{ "openapi" : "3.1.0", "components" : { "schemas" : { "LocalDateTime" : { "type" : "string", "format" : "date-time", "examples" : [ "2022-03-10T12:15:50" ] }, "FilerCheckResponse" : { "type" : "object", "description" : "This response returns information about the status of a Filer API Token and User API Token.", "title" : "Filer Check Response", "properties" : { "tracking" : { "type" : "string", "description" : "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.", "title" : "Tracking Identifier" }, "locator" : { "type" : "string", "description" : "A short identifier that can be used by the EDGAR Help Desk to locate the tracking identifier within the EDGAR system.", "title" : "Tracking Locator" }, "messages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Message" }, "description" : "A list of messages providing details associated with the filer management response.", "title" : "Messages" }, "canFile" : { "type" : "boolean", "description" : "boolean value describing if a filing can be made or not with the provided user api token, filer api token and cik", "title" : "Can File" }, "confirmationDueDate" : { "$ref" : "#/components/schemas/ZonedDateTime", "type" : "string", "examples" : [ "2025-12-31T11:59:59-05:00" ], "description" : "Date that confirmation is due (RFC3339 formatted date-time)", "title" : "Confirmation Due Date" }, "filerApiTokenExpirationDate" : { "$ref" : "#/components/schemas/ZonedDateTime", "type" : "string", "examples" : [ "2025-12-31T11:59:59-05:00" ], "description" : "Date that the Filer API Token expires (RFC3339 formatted date-time)", "title" : "Filer API Token Expiration Date" }, "userApiTokenExpirationDate" : { "$ref" : "#/components/schemas/ZonedDateTime", "type" : "string", "examples" : [ "2025-12-31T11:59:59-05:00" ], "description" : "Date that the User API Token expires (RFC3339 formatted date-time)", "title" : "User API Token Expiration Date" } } }, "ListSubmissionResponse" : { "type" : "object", "description" : "Provides a response that contains a list of responses as well as a top-level list of messages.", "title" : "Submission Response List", "properties" : { "tracking" : { "type" : "string", "description" : "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.", "title" : "Tracking Identifier" }, "locator" : { "type" : "string", "description" : "A short identifier that can be used by the EDGAR Help Desk to locate the tracking identifier within the EDGAR system.", "title" : "Tracking Locator" }, "status" : { "type" : "string", "enum" : [ "RECEIVED", "REJECTED", "FAILED" ], "examples" : [ "RECEIVED", "REJECTED", "FAILED" ], "description" : "A short string that indicates the status of filing that was transmitted to EDGAR.\n* `RECEIVED` - The transmission has been received by EDGAR and an accession number has been generated\n* `REJECTED` - The transmission was rejected by EDGAR and will not be processed\n* `FAILED` - The transmission failed to be transmitted to EDGAR and will not be processed`\n", "title" : "Transmission Status" }, "responses" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubmissionResponseItem" }, "description" : "A list of submission responses.", "title" : "Responses" }, "messages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Message" }, "description" : "A list of messages associated with the submission response. This should include more process/submission level errors like why a submission might be rejected from the API level.", "title" : "Messages" }, "transmissionStatus" : { "type" : "string", "deprecated" : true, "enum" : [ "RECEIVED", "REJECTED", "FAILED" ], "examples" : [ "RECEIVED", "REJECTED", "FAILED" ], "description" : "A short string that indicates the status of filing that was transmitted to EDGAR.\n* `RECEIVED` - The transmission has been received by EDGAR and an accession number has been generated\n* `REJECTED` - The transmission was rejected by EDGAR and will not be processed\n* `FAILED` - The transmission failed to be transmitted to EDGAR and will not be processed`\n", "title" : "Transmission Status" } } }, "SubmissionRegistrant" : { "type" : "object", "description" : "Data item representing a registrant that can be returned as part of the status for a given submission.", "title" : "Submission Registrant", "properties" : { "cik" : { "type" : "string", "description" : "The CIK (Central Index Key) as it would appear on the Submission Status as part of the submission registrant information", "title" : "CIK" }, "company" : { "type" : "string", "description" : "The COMPANY as it would appear on the Submission Status as part of the submission registrant information", "title" : "Company Name" }, "filingRole" : { "type" : "string", "description" : "The FILING ROLE for the registrant as it would appear on the Submission Status as part of the submission registrant information. Possible values are `Primary Registrant`, `Primary Subject`, `Nonprimary Registrant`, `Nonprimary filed by registrant`, `Nonprimary Reporting owner`, `Nonprimary Serial`, `Primary Subject Combo`, `Ownership Reporting Owner`.", "title" : "Filing Role" }, "formType" : { "type" : "string", "description" : "The FORM TYPE as it would appear on the Submission Status as part of the submission registrant information", "title" : "Form Type" }, "fileNumbers" : { "type" : "array", "items" : { "type" : "string" }, "description" : "List of File Numbers for this Registrant", "title" : "File Numbers" } } }, "Message" : { "type" : "object", "description" : "A Message is a response, from EDGAR, giving detail about an interaction with the API. When messages are provided by the API this standard format allows the same parsing to be performed across all instances.", "title" : "Message", "properties" : { "type" : { "$ref" : "#/components/schemas/MessageType", "type" : "string", "examples" : [ "NOTICE" ], "description" : "The type of the message being returned regarding how severe it is or what type of message it contains.\n* `INFO` - The message is intended only for informational purposes and does not necessarily require action\n* `NOTICE` - There is something that may require human intervention or interaction but it has not prevented filing\n* `WARNING` - There is an issue with the filing itself or some of the information provided but it may not prevent filing\n* `ERROR` - There has been an error that either prevented the filing from being submitted or stopped the processing of the submission", "title" : "Type" }, "content" : { "type" : "string", "examples" : [ "The Filer API Key making this request will expire in less than two weeks." ], "description" : "The content of the message intended to be interpreted by a human consumer of the API output.", "title" : "Content" } } }, "SEFMessage" : { "type" : "object", "description" : "A Submission Error Message is a message that has come from EDGAR and is provided when the submission has reached a final disposition after encountering errors in EDGAR", "title" : "Submission Error Message", "properties" : { "type" : { "$ref" : "#/components/schemas/MessageType", "type" : "string", "examples" : [ "NOTICE" ], "description" : "The type of the message being returned regarding how severe it is or what type of message it contains.\n* `INFO` - The message is intended only for informational purposes and does not necessarily require action\n* `NOTICE` - There is something that may require human intervention or interaction but it has not prevented filing\n* `WARNING` - There is an issue with the filing itself or some of the information provided but it may not prevent filing\n* `ERROR` - There has been an error that either prevented the filing from being submitted or stopped the processing of the submission", "title" : "Type" }, "content" : { "type" : "string", "examples" : [ "The Filer API Key making this request will expire in less than two weeks." ], "description" : "The content of the message intended to be interpreted by a human consumer of the API output.", "title" : "Content" }, "errorNumber" : { "type" : "integer", "format" : "int32", "description" : "An error code that corresponds to the error label", "title" : "Error Number" }, "docSequenceNum" : { "type" : "integer", "format" : "int32", "description" : "The document sequence number the error message refers to", "title" : "Document Sequence Number" }, "lineNumber" : { "type" : "integer", "format" : "int32", "description" : "The line number the error occurs on, 0 if not applicable", "title" : "Line Number" }, "lineOffset" : { "type" : "integer", "format" : "int16", "description" : "The character offset on the line that the error occurs on, 0 if not applicable", "title" : "Line Offset" }, "context" : { "type" : "string", "description" : "Additional information related to the error context, 'none' if not applicable", "title" : "Context" }, "errorLabel" : { "type" : "string", "examples" : [ "INCONSISTENT_TAG_VALUE" ], "description" : "A unique label for the error", "title" : "Error Label" } } }, "DelegationInfo" : { "type" : "object", "description" : "A collection of fields pertaining to delegation", "title" : "Delegation Information", "properties" : { "entityCik" : { "type" : "string", "examples" : [ "0000350001" ], "description" : "The Central Index Key is a 10 digit unique identifier of a filer", "title" : "Entity CIK" }, "entityName" : { "type" : "string", "examples" : [ "XYZ CORPORATION" ], "description" : "Name of a filer", "title" : "Entity Name" }, "status" : { "type" : "string", "examples" : [ "ACTIVE" ], "description" : "Delegation status", "title" : "Status" }, "isRequest" : { "type" : "boolean", "examples" : [ true ], "description" : "Is delegation a request?", "title" : "Is Request" }, "autoAddUsers" : { "type" : "boolean", "examples" : [ true ], "description" : "Is auto add users flag selected for active delegations", "title" : "Auto Add Users" }, "lastUpdated" : { "type" : "string", "examples" : [ "2025-12-31T11:59:59-05:00" ], "description" : "Timestamp when last delegation record was updated (RFC3339 formatted date-time).", "title" : "Last Updated" } } }, "Issuer" : { "type" : "object", "properties" : { "cik" : { "type" : "string" }, "companyName" : { "type" : "string" }, "docTypeCode" : { "type" : "string" } } }, "EmailRole" : { "type" : "object", "description" : "Represents a request for updating the roles of a user in Filer Management", "title" : "Email Role", "properties" : { "email" : { "type" : "string", "description" : "String value belonging to the user whose roles are getting updated", "title" : "Email" }, "inAdminRole" : { "type" : "boolean", "description" : "Boolean value describing if the user is going to be added to the filer administrator role'", "title" : "In Admin Role" }, "inTechAdminRole" : { "type" : "boolean", "description" : "Boolean value describing if the user is going to be added to the technical administrator role'", "title" : "In Technical Admin Role" }, "inUserRole" : { "type" : "boolean", "description" : "Boolean value describing if the user is going to be added to the user role'", "title" : "In User Role" } } }, "SubmissionStatusSeriesItem" : { "type" : "object", "description" : "Details about a Series related to a Submission", "title" : "Submission Series", "properties" : { "id" : { "type" : "string", "description" : "Identifier for the series", "title" : "ID" }, "name" : { "type" : "string", "description" : "Name of the series", "title" : "Name" }, "oldName" : { "type" : "string", "description" : "Name of the series before the change induced by this filing, if a change was made.", "title" : "Old Name" } } }, "SubmissionProcessingStatus" : { "type" : "string", "enum" : [ "PROCESSING", "SUSPENDED", "DISSEMINATED", "NO_STATUS", "BLOCKED", "DONE", "ACCEPTED" ], "examples" : [ "SUSPENDED", "DONE", "ACCEPTED" ], "description" : "A short string that indicates the status of a submission within the EDGAR system.\n* `PROCESSING` - The submission is currently being processed by EDGAR\n* `SUSPENDED` - The submission has been suspended by EDGAR\n* `DISSEMINATED` - The submission has been processed and disseminated\n* `NO_STATUS` - The current status of the submission cannot be determined\n* `BLOCKED` - The submission has reached the blocked status and is awaiting further action\n* `DONE` - The submission has reached the DONE state in the EDGAR system and no further processing is expected\n* `ACCEPTED` - The submission has been accepted by EDGAR\n", "title" : "Submission Processing Status" }, "ListSubmissionStatusResponse" : { "type" : "object", "description" : "Provides a response that contains a list of submission status responses as well as a top-level list of messages.", "title" : "Submission Status Response List", "properties" : { "tracking" : { "type" : "string", "description" : "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.", "title" : "Tracking Identifier" }, "locator" : { "type" : "string", "description" : "A short identifier that can be used by the EDGAR Help Desk to locate the tracking identifier within the EDGAR system.", "title" : "Tracking Locator" }, "responses" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubmissionStatusResponseItem" }, "description" : "A list of submission status responses.", "title" : "Submission Status Responses" }, "messages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Message" }, "description" : "A list of messages associated with the submission response list. This should include more process/submission level errors like why a submission might be rejected from the API level.", "title" : "Messages" } } }, "FilerInfo" : { "type" : "object", "description" : "A collection of fields pertaining to the overall information on a filer", "title" : "Filer Information", "properties" : { "cik" : { "type" : "string", "examples" : [ "0000000000s." ], "description" : "The Central Index Key is a 10 digit unique identifier of a filer", "title" : "CIK" }, "stateCode" : { "type" : "string", "examples" : [ "TX" ], "description" : "The state code of the filer", "title" : "State Code" }, "irsNumber" : { "type" : "string", "examples" : [ "000000000" ], "description" : "Number used by IRS to track filer", "title" : "IRS Number" }, "entityStatus" : { "type" : "string", "examples" : [ "A" ], "description" : "The status of the filer\n\nA - Active\n\n...", "title" : "Entity Status" }, "entityType" : { "type" : "string", "examples" : [ "A" ], "description" : "The type of entity\n\nA - Agent\n\nF - Filer", "title" : "Entity Type" }, "dateIncorporated" : { "type" : "string", "format" : "date", "examples" : [ "2025-08-06" ], "description" : "The date that the filer incorporated (YYYY-MM-DD)", "title" : "Date Incorporated" }, "deleteFlag" : { "type" : "integer", "format" : "int32", "examples" : [ 0 ], "description" : "A flag to determine if the filer has been deleted", "title" : "Delete Flag" }, "sicCode" : { "type" : "string", "examples" : [ "4512" ], "description" : "...", "title" : "SIC Code" }, "fyEnd" : { "type" : "string", "examples" : [ "1231" ], "description" : "The data that marks the end of the filer's fiscal year", "title" : "Fiscal Year End" }, "individualOrCompany" : { "type" : "string", "examples" : [ "..." ], "description" : "Denotes if the filer is a company or an individual\n\nC - Company\n\nI - Individual", "title" : "Individual of Company" }, "specialFilerType" : { "type" : "string", "examples" : [ "..." ], "description" : "...", "title" : "Special Filer Type" }, "legalEntityIdentifier" : { "type" : "string", "examples" : [ "54930084UKLVMY22DS16" ], "description" : "Legal entity identifier", "title" : "Legal Entity Identifier" }, "repFileNum" : { "type" : "string", "examples" : [ "111-123456-00" ], "description" : "Reporting Filer Number", "title" : "Reporting File Number" }, "dateModified" : { "type" : "string", "examples" : [ "2024-01-02T12:00:00.000000Z" ], "description" : "Date modified", "title" : "Date Modified" }, "entityName" : { "type" : "string", "examples" : [ "Disney Enterprises Inc" ], "description" : "The name of the filer", "title" : "Entity Name" }, "entityDbaName" : { "type" : "string", "examples" : [ "..." ], "description" : "...", "title" : "Entity DBA Name" }, "entityForeignName" : { "type" : "string", "examples" : [ "..." ], "description" : "...", "title" : "Entity Foreign Name" }, "mailIsForeignAddress" : { "type" : "string", "examples" : [ "true" ], "description" : "Is mailing address of a filer a foreign address", "title" : "Is Foreign Address (mailing)" }, "mailStreet1" : { "type" : "string", "examples" : [ "123 Broadway" ], "description" : "Mailing address of a filer", "title" : "Mail Street 1" }, "mailStreet2" : { "type" : "string", "examples" : [ "Suite 200" ], "description" : "Supplemental information on the mailing address", "title" : "Mail Street 2" }, "mailCity" : { "type" : "string", "examples" : [ "Dallas" ], "description" : "The city of the mailing address", "title" : "Mail City" }, "mailStateCode" : { "type" : "string", "examples" : [ "TX" ], "description" : "The state/country code of the mailing address", "title" : "Mail State/Country Code" }, "mailForeignState" : { "type" : "string", "examples" : [ "Maharashtra" ], "description" : "Foreign state name of the mailing address", "title" : "Mail Foreign State" }, "mailZip" : { "type" : "string", "examples" : [ "75240" ], "description" : "Zip code of the mailing address", "title" : "Mail Zip" }, "businessIsForeignAddress" : { "type" : "string", "examples" : [ "true" ], "description" : "Is business address of a filer a foreign address", "title" : "Is Foreign Address (business)" }, "businessStreet1" : { "type" : "string", "examples" : [ "123 Broadway" ], "description" : "The business street address of the filer", "title" : "Business Street 1" }, "businessStreet2" : { "type" : "string", "examples" : [ "Suite 200" ], "description" : "Supplemental information on the business address", "title" : "Business Street 2" }, "businessCity" : { "type" : "string", "examples" : [ "Dallas" ], "description" : "City of the business address", "title" : "Business City" }, "businessStateCode" : { "type" : "string", "examples" : [ "TX" ], "description" : "State code/country of the business address", "title" : "Business State/Country Code" }, "businessForeignState" : { "type" : "string", "examples" : [ "Maharashtra" ], "description" : "Foreign state name of the business address", "title" : "Business Foreign State" }, "businessZip" : { "type" : "string", "examples" : [ "75240" ], "description" : "Zip code of the business address", "title" : "Business Zip" }, "peoStreet1" : { "type" : "string", "examples" : [ "..." ], "description" : "...", "title" : "..." }, "peoStreet2" : { "type" : "string", "examples" : [ "..." ], "description" : "...", "title" : "..." }, "peoCity" : { "type" : "string", "examples" : [ "..." ], "description" : "...", "title" : "..." }, "peoStateCode" : { "type" : "string", "examples" : [ "..." ], "description" : "...", "title" : "..." }, "peoZip" : { "type" : "string", "examples" : [ "..." ], "description" : "...", "title" : "..." }, "acctName" : { "type" : "string", "examples" : [ "James Smith" ], "description" : "Name of the accounting at the filer", "title" : "Accounting Name" }, "acctPhone" : { "type" : "string", "examples" : [ "555-555-5555" ], "description" : "Phone number of the accounting at the filer", "title" : "Accounting Phone Number" }, "acctStreet1" : { "type" : "string", "examples" : [ "123 Broadway" ], "description" : "The accounting street address of the filer", "title" : "Accounting Street 1" }, "acctStreet2" : { "type" : "string", "examples" : [ "123 Broadway" ], "description" : "Supplemental information on the accounting address", "title" : "Accounting Street 2" }, "acctCity" : { "type" : "string", "examples" : [ "Dallas" ], "description" : "City of the accounting address", "title" : "Accounting City" }, "acctStateCode" : { "type" : "string", "examples" : [ "TX" ], "description" : "State code/country of the accounting address", "title" : "Accounting State/Country Code" }, "acctZip" : { "type" : "string", "examples" : [ "75240" ], "description" : "Zip code of the accounting address", "title" : "Accounting Zip" }, "acctEmail" : { "type" : "string", "examples" : [ "james.smith@somecompany.com" ], "description" : "Email address of the accounting at the filer", "title" : "Accounting Email" }, "contName" : { "type" : "string", "examples" : [ "James Smith" ], "description" : "Name of the contact at the filer", "title" : "Contact Name" }, "contPhone" : { "type" : "string", "examples" : [ "555-555-5555" ], "description" : "Phone number of the contact at the filer", "title" : "Contact Phone Number" }, "contEmail" : { "type" : "string", "examples" : [ "james.smith@somecompany.com" ], "description" : "Email address of the contact at the filer", "title" : "Contact Email" }, "mailingPhone" : { "type" : "string", "examples" : [ "555-555-5555" ], "description" : "Mailing Phone number of the filer", "title" : "Mailing Phone Number" }, "businessPhone" : { "type" : "string", "examples" : [ "555-555-5555" ], "description" : "Business Phone number of the filer", "title" : "Business Phone Number" }, "ccc" : { "type" : "string", "examples" : [ "@1B2C3d4" ], "description" : "The CCC is the CIK Confirmation Code", "title" : "CCC" }, "confirmationDueDate" : { "type" : "string", "format" : "date", "examples" : [ "2025-08-06" ], "description" : "Date in which a filer must confirm the filing information and users are up to date and correct (YYYY-MM-DD)", "title" : "Confirmation Due Date" }, "singleEntityCompany" : { "type" : "boolean", "examples" : [ 0 ], "description" : "Boolean field to denote if filer is a single entity company or not\n\n0 - False\n\n1 - True", "title" : "Single Entity Company" }, "website" : { "type" : "string", "examples" : [ "www.somecompany.com" ], "description" : "Company website", "title" : "Website" }, "series" : { "type" : "array", "examples" : [ "..." ], "items" : { }, "description" : "Series Class information", "title" : "Series" } } }, "ClassItem" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "oldName" : { "type" : "string" }, "seriesId" : { "type" : "string" }, "tickerSymbol" : { "type" : "string" }, "oldTickerSymbol" : { "type" : "string" } } }, "SubmissionMode" : { "type" : "string", "enum" : [ "LIVE", "TEST" ], "examples" : [ "LIVE" ], "description" : "The submission mode of a filing:\n* `TEST` - A submission mode that allows a filing to be tested for correctness\n* `LIVE` - A submission mode that allows a filing to be evaluated as an official filing\nFor more information see the EDGAR Filing Manual\n", "title" : "Submission Mode" }, "ZonedDateTime" : { "type" : "string", "format" : "date-time", "examples" : [ "2022-03-10T12:15:50-04:00" ] }, "IssuingEntity" : { "type" : "object", "properties" : { "cik" : { "type" : "string" }, "companyName" : { "type" : "string" }, "accepted" : { "type" : "boolean" } } }, "SubmissionStatusClassItem" : { "type" : "object", "description" : "Details about a Class related to a Submission", "title" : "Submission Class", "properties" : { "id" : { "type" : "string", "description" : "Identifier for the class", "title" : "ID" }, "name" : { "type" : "string", "description" : "Name of the class", "title" : "Name" }, "oldName" : { "type" : "string", "description" : "Name of the class before the change induced by this filing, if a change was made.", "title" : "Old Name" }, "seriesId" : { "type" : "string", "description" : "Identifier for the related series", "title" : "Series ID" }, "tickerSymbol" : { "type" : "string", "description" : "Ticker symbol for the class", "title" : "Ticker Symbol" }, "oldTickerSymbol" : { "type" : "string", "description" : "Ticker symbol for the class before the change induced by this filing, if a change was made.", "title" : "Old Ticker Symbol" } } }, "UpdateCCC" : { "type" : "object", "description" : "Used to update the CCC of a filer", "title" : "Update CCC", "properties" : { "ccc" : { "type" : "string", "examples" : [ "Abcd123@" ], "description" : "The current CCC of the filer", "title" : "CCC" }, "newCCC" : { "type" : "string", "examples" : [ "@1B2C3d4" ], "description" : "The new value of the CCC for the filer", "title" : "New CCC" } } }, "MultipleAccessionNumberRequest" : { "type" : "object", "required" : [ "accessionNumbers" ], "description" : "Allows a list of accession numbers to be presented to the Submission Status resource in order to request status on multiple submissions simultaneously.", "title" : "Submission Number Request List", "properties" : { "accessionNumbers" : { "type" : "array", "maxItems" : 25, "minItems" : 1, "items" : { "type" : "string" }, "description" : "The list of accession numbers that the caller wants to receive status for, maximum 25", "title" : "Accession Number List" } } }, "FilerInfoResponse" : { "type" : "object", "description" : "A filer info response is a response that encapsulates information regarding a filer", "title" : "Filer Info Response", "properties" : { "tracking" : { "type" : "string", "description" : "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.", "title" : "Tracking Identifier" }, "locator" : { "type" : "string", "description" : "A short identifier that can be used by the EDGAR Help Desk to locate the tracking identifier within the EDGAR system.", "title" : "Tracking Locator" }, "messages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Message" }, "description" : "A list of messages providing details associated with the filer management response.", "title" : "Messages" }, "filerInfo" : { "type" : "array", "oneOf" : [ { "$ref" : "#/components/schemas/FilerInfo" } ], "items" : { "$ref" : "#/components/schemas/FilerInfo" }, "description" : "An list containing object that contains a list of fields pertaining to a filer's information", "title" : "Filer Information" } } }, "SubmissionItemInformation" : { "type" : "object", "description" : "Data item representing information about ITEM(s) associated with the submission.", "title" : "Submission Item Information", "properties" : { "submissionAccessionNumber" : { "type" : "string", "description" : "The accession number associated with any item submissions.", "title" : "Submission Accession Number" }, "submissionFormType" : { "type" : "string", "description" : "The FORM TYPE as it would appear on the Submission Status", "title" : "Submission Form Type" }, "items" : { "type" : "array", "items" : { "type" : "string" }, "description" : "The list of ITEM(s) as it would appear on the Submission Status", "title" : "Items" } } }, "MessageType" : { "type" : "string", "enum" : [ "INFO", "NOTICE", "WARNING", "ERROR" ], "description" : "The type of the message being returned regarding how severe it is or what type of message it contains.", "title" : "Message Type" }, "SeriesItem" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "oldName" : { "type" : "string" } } }, "DelegationInfoResponse" : { "type" : "object", "description" : "A filer info response is a response that encapsulates information regarding a filer", "title" : "Delegation Info Response", "properties" : { "tracking" : { "type" : "string", "description" : "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.", "title" : "Tracking Identifier" }, "locator" : { "type" : "string", "description" : "A short identifier that can be used by the EDGAR Help Desk to locate the tracking identifier within the EDGAR system.", "title" : "Tracking Locator" }, "messages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Message" }, "description" : "A list of messages providing details associated with the filer management response.", "title" : "Messages" }, "delegationsTo" : { "type" : "array", "oneOf" : [ { "$ref" : "#/components/schemas/DelegationInfo" } ], "items" : { "$ref" : "#/components/schemas/DelegationInfo" }, "description" : "An list containing objects made up of properties related to delegation", "title" : "Delegation To Information" }, "delegationsFrom" : { "type" : "array", "oneOf" : [ { "$ref" : "#/components/schemas/DelegationInfo" } ], "items" : { "$ref" : "#/components/schemas/DelegationInfo" }, "description" : "An list containing objects made up of properties related to delegation", "title" : "Delegation From Information" } } }, "Condition" : { "type" : "string", "enum" : [ "ACCEPTING", "ACCEPTING_WITH_TECHNICAL_DIFFICULTIES", "ACCEPTING_AFTER_HOURS", "ACCEPTING_AFTER_HOURS_WITH_TECHNICAL_DIFFICULTIES", "OUTSIDE_OPERATING_HOURS", "NO_COMMUNICATION" ], "description" : "The current operating state of EDGAR", "title" : "Condition" }, "SubmissionStatusResponseItem" : { "type" : "object", "description" : "A submission status response is a single item in a list of submission responses.", "title" : "Submission Status Response Item", "properties" : { "submissionAccessionNumber" : { "type" : "string", "description" : "The accession number associated with any item submissions.", "title" : "Submission Accession Number" }, "submissionFormType" : { "type" : "string", "description" : "The FORM TYPE as it would appear on the Submission Status", "title" : "Submission Form Type" }, "items" : { "type" : "array", "items" : { "type" : "string" }, "description" : "The list of ITEM(s) as it would appear on the Submission Status", "title" : "Items" }, "accessionNumber" : { "type" : [ "string", "null" ], "examples" : [ "0000000001-22-000001" ], "description" : "The unique number associated with an transmitted submission.", "title" : "Accession Number" }, "messages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Message" }, "description" : "A list of messages providing details associated with the submission response. This could range from a notification about the filing to errors related to the state of the filing. This should include things like submission error codes as well as other EDGAR output.", "title" : "Messages" }, "mode" : { "$ref" : "#/components/schemas/SubmissionMode", "type" : "object" }, "status" : { "type" : "string", "enum" : [ "PROCESSING", "SUSPENDED", "DISSEMINATED", "NO_STATUS", "BLOCKED", "DONE", "ACCEPTED" ], "examples" : [ "SUSPENDED", "DONE", "ACCEPTED" ], "description" : "A short string that indicates the status of a submission within the EDGAR system.\n* `PROCESSING` - The submission is currently being processed by EDGAR\n* `SUSPENDED` - The submission has been suspended by EDGAR\n* `DISSEMINATED` - The submission has been processed and disseminated\n* `NO_STATUS` - The current status of the submission cannot be determined\n* `BLOCKED` - The submission has reached the blocked status and is awaiting further action\n* `DONE` - The submission has reached the DONE state in the EDGAR system and no further processing is expected\n* `ACCEPTED` - The submission has been accepted by EDGAR\n", "title" : "Submission Processing Status" }, "company" : { "type" : "string", "description" : "The COMPANY as it would appear on the Submission Status", "title" : "Company Name" }, "documentCount" : { "type" : "integer", "format" : "int32", "description" : "The number of DOCUMENTS as it would appear on the Submission Status", "title" : "Document Count" }, "formType" : { "type" : "string", "description" : "The FORM TYPE as it would appear on the Submission Status", "title" : "Form Type" }, "receivedDate" : { "$ref" : "#/components/schemas/ZonedDateTime", "type" : "string", "examples" : [ "2025-12-31T11:59:59-05:00" ], "description" : "The RECEIVED DATE as it would appear on the Submission Status (RFC3339 formatted date-time)", "title" : "Received Date" }, "filingDate" : { "$ref" : "#/components/schemas/ZonedDateTime", "type" : "string", "examples" : [ "2025-12-31T11:59:59-05:00" ], "description" : "The Filing DATE as it would appear on the Submission Status (RFC3339 formatted date-time)", "title" : "Filing Date" }, "acceptedDate" : { "$ref" : "#/components/schemas/ZonedDateTime", "type" : "string", "examples" : [ "2025-12-31T11:59:59-05:00" ], "description" : "When present: ACCEPTED DATE as it would appear on the Submission Status (RFC3339 formatted date-time)", "title" : "Accepted Date" }, "suspendedDate" : { "$ref" : "#/components/schemas/ZonedDateTime", "type" : "string", "examples" : [ "2025-12-31T11:59:59-05:00" ], "description" : "When present: SUSPENDED DATE as it would appear on the Submission Status (RFC3339 formatted date-time)", "title" : "Suspended Date" }, "final" : { "type" : "boolean", "description" : "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.", "title" : "Final Disposition" }, "submissionMessages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SEFMessage" }, "description" : "A list messages that are derived from the Submission Error File. These messages include informationabout the error including a human-readable description and metadata about the message like the line numberor error code.", "title" : "Submission Messages" }, "fileNumbers" : { "type" : "array", "items" : { "type" : "string" }, "description" : "The list of FILE NUMBER(s) as it would appear on the Submission Status", "title" : "File Numbers" }, "notification" : { "type" : "string", "format" : "base64", "description" : "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.", "title" : "Notification File" }, "registrants" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubmissionRegistrant" }, "description" : "A list of registrants associated with the submission as they would appear in the REGISTRANT(s) section of the Submission Notification.", "title" : "Submission Registrants" }, "seriesInformation" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubmissionStatusSeriesItem" }, "description" : "A list of series information (if present) for the submission.", "title" : "Submission Series Items" }, "classInformation" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubmissionStatusClassItem" }, "description" : "A list of class information (if present) for the submission.", "title" : "Submission Class Items" }, "submissionProcessingStatus" : { "type" : "string", "deprecated" : true, "enum" : [ "PROCESSING", "SUSPENDED", "DISSEMINATED", "NO_STATUS", "BLOCKED", "DONE", "ACCEPTED" ], "examples" : [ "SUSPENDED", "DONE", "ACCEPTED" ], "description" : "A short string that indicates the status of a submission within the EDGAR system.\n* `PROCESSING` - The submission is currently being processed by EDGAR\n* `SUSPENDED` - The submission has been suspended by EDGAR\n* `DISSEMINATED` - The submission has been processed and disseminated\n* `NO_STATUS` - The current status of the submission cannot be determined\n* `BLOCKED` - The submission has reached the blocked status and is awaiting further action\n* `DONE` - The submission has reached the DONE state in the EDGAR system and no further processing is expected\n* `ACCEPTED` - The submission has been accepted by EDGAR\n", "title" : "Submission Processing Status" } } }, "FilerCCCResponse" : { "type" : "object", "description" : "This response will be used to return the response when a Filer's CCC has been updated. ", "title" : "Filer CCC Update Response", "properties" : { "tracking" : { "type" : "string", "description" : "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.", "title" : "Tracking Identifier" }, "locator" : { "type" : "string", "description" : "A short identifier that can be used by the EDGAR Help Desk to locate the tracking identifier within the EDGAR system.", "title" : "Tracking Locator" }, "messages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Message" }, "description" : "A list of messages providing details associated with the filer management response.", "title" : "Messages" }, "filerCCC" : { "type" : "string", "examples" : [ "@1B2C3d4" ], "description" : "Returns a Filer's ccc", "title" : "Filer's CCC'" } } }, "SingleSubmissionStatusResponse" : { "type" : "object", "description" : "A submission status response is a response to a request for submission status. It expands on the Submission Response by including additional data regarding the submission's status in EDGAR.", "title" : "Submission Status Response", "properties" : { "submissionAccessionNumber" : { "type" : "string", "description" : "The accession number associated with any item submissions.", "title" : "Submission Accession Number" }, "submissionFormType" : { "type" : "string", "description" : "The FORM TYPE as it would appear on the Submission Status", "title" : "Submission Form Type" }, "items" : { "type" : "array", "items" : { "type" : "string" }, "description" : "The list of ITEM(s) as it would appear on the Submission Status", "title" : "Items" }, "tracking" : { "type" : "string", "description" : "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.", "title" : "Tracking Identifier" }, "locator" : { "type" : "string", "description" : "A short identifier that can be used by the EDGAR Help Desk to locate the tracking identifier within the EDGAR system.", "title" : "Tracking Locator" }, "accessionNumber" : { "type" : [ "string", "null" ], "examples" : [ "0000000001-22-000001" ], "description" : "The unique number associated with an transmitted submission.", "title" : "Accession Number" }, "messages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Message" }, "description" : "A list of messages providing details associated with the submission response. This could range from a notification about the filing to errors related to the state of the filing. This should include things like submission error codes as well as other EDGAR output.", "title" : "Messages" }, "mode" : { "$ref" : "#/components/schemas/SubmissionMode", "type" : "object" }, "status" : { "type" : "string", "enum" : [ "PROCESSING", "SUSPENDED", "DISSEMINATED", "NO_STATUS", "BLOCKED", "DONE", "ACCEPTED" ], "examples" : [ "SUSPENDED", "DONE", "ACCEPTED" ], "description" : "A short string that indicates the status of a submission within the EDGAR system.\n* `PROCESSING` - The submission is currently being processed by EDGAR\n* `SUSPENDED` - The submission has been suspended by EDGAR\n* `DISSEMINATED` - The submission has been processed and disseminated\n* `NO_STATUS` - The current status of the submission cannot be determined\n* `BLOCKED` - The submission has reached the blocked status and is awaiting further action\n* `DONE` - The submission has reached the DONE state in the EDGAR system and no further processing is expected\n* `ACCEPTED` - The submission has been accepted by EDGAR\n", "title" : "Submission Processing Status" }, "company" : { "type" : "string", "description" : "The COMPANY as it would appear on the Submission Status", "title" : "Company Name" }, "documentCount" : { "type" : "integer", "format" : "int32", "description" : "The number of DOCUMENTS as it would appear on the Submission Status", "title" : "Document Count" }, "formType" : { "type" : "string", "description" : "The FORM TYPE as it would appear on the Submission Status", "title" : "Form Type" }, "receivedDate" : { "$ref" : "#/components/schemas/ZonedDateTime", "type" : "string", "examples" : [ "2025-12-31T11:59:59-05:00" ], "description" : "The RECEIVED DATE as it would appear on the Submission Status (RFC3339 formatted date-time)", "title" : "Received Date" }, "filingDate" : { "$ref" : "#/components/schemas/ZonedDateTime", "type" : "string", "examples" : [ "2025-12-31T11:59:59-05:00" ], "description" : "The Filing DATE as it would appear on the Submission Status (RFC3339 formatted date-time)", "title" : "Filing Date" }, "acceptedDate" : { "$ref" : "#/components/schemas/ZonedDateTime", "type" : "string", "examples" : [ "2025-12-31T11:59:59-05:00" ], "description" : "When present: ACCEPTED DATE as it would appear on the Submission Status (RFC3339 formatted date-time)", "title" : "Accepted Date" }, "suspendedDate" : { "$ref" : "#/components/schemas/ZonedDateTime", "type" : "string", "examples" : [ "2025-12-31T11:59:59-05:00" ], "description" : "When present: SUSPENDED DATE as it would appear on the Submission Status (RFC3339 formatted date-time)", "title" : "Suspended Date" }, "final" : { "type" : "boolean", "description" : "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.", "title" : "Final Disposition" }, "submissionMessages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SEFMessage" }, "description" : "A list messages that are derived from the Submission Error File. These messages include informationabout the error including a human-readable description and metadata about the message like the line numberor error code.", "title" : "Submission Messages" }, "fileNumbers" : { "type" : "array", "items" : { "type" : "string" }, "description" : "The list of FILE NUMBER(s) as it would appear on the Submission Status", "title" : "File Numbers" }, "notification" : { "type" : "string", "description" : "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.", "title" : "Notification File" }, "registrants" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubmissionRegistrant" }, "description" : "A list of registrants associated with the submission as they would appear in the REGISTRANT(s) section of the Submission Notification.", "title" : "Submission Registrants" }, "seriesInformation" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubmissionStatusSeriesItem" }, "description" : "A list of series information (if present) for the submission.", "title" : "Submission Series Items" }, "classInformation" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubmissionStatusClassItem" }, "description" : "A list of class information (if present) for the submission.", "title" : "Submission Class Items" }, "submissionProcessingStatus" : { "type" : "string", "deprecated" : true, "enum" : [ "PROCESSING", "SUSPENDED", "DISSEMINATED", "NO_STATUS", "BLOCKED", "DONE", "ACCEPTED" ], "examples" : [ "SUSPENDED", "DONE", "ACCEPTED" ], "description" : "A short string that indicates the status of a submission within the EDGAR system.\n* `PROCESSING` - The submission is currently being processed by EDGAR\n* `SUSPENDED` - The submission has been suspended by EDGAR\n* `DISSEMINATED` - The submission has been processed and disseminated\n* `NO_STATUS` - The current status of the submission cannot be determined\n* `BLOCKED` - The submission has reached the blocked status and is awaiting further action\n* `DONE` - The submission has reached the DONE state in the EDGAR system and no further processing is expected\n* `ACCEPTED` - The submission has been accepted by EDGAR\n", "title" : "Submission Processing Status" } } }, "ErrorResponse" : { "type" : "object", "description" : "When an error occurs in the API this is the standard response.", "title" : "Error Response", "properties" : { "tracking" : { "type" : "string", "description" : "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.", "title" : "Tracking Identifier" }, "locator" : { "type" : "string", "description" : "A short identifier that can be used by the EDGAR Help Desk to locate the tracking identifier within the EDGAR system.", "title" : "Tracking Locator" }, "messages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Message" } } } }, "Response" : { "type" : "object", "description" : "Provides information on the current operating state of EDGAR", "title" : "Status Response", "properties" : { "tracking" : { "type" : "string", "description" : "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.", "title" : "Tracking Identifier" }, "locator" : { "type" : "string", "description" : "A short identifier that can be used by the EDGAR Help Desk to locate the tracking identifier within the EDGAR system.", "title" : "Tracking Locator" }, "condition" : { "$ref" : "#/components/schemas/Condition", "type" : "string", "examples" : [ "OUTSIDE_OPERATING_HOURS" ], "description" : "Represents the current operating state of EDGAR.\n\nACCEPTING - EDGAR is available because EDGAR is reporting that it is operational and within operating hours.\n\nACCEPTING_WITH_TECHNICAL_DIFFICULTIES - EDGAR is experiencing technical difficulties. Consult the EDGAR News and Announcements page on SEC.gov (https://www.sec.gov/submit-filings/edgar-news-announcements) for more information.\n\nACCEPTING_AFTER_HOURS - EDGAR is operating normally. Certain submissions listed in the EDGAR Filer Manual for which transmission begins now (and is completed prior to 10 p.m.) will be treated as filed today. Other submissions will receive a filing date of the next business day.\n\nACCEPTING_AFTER_HOURS_WITH_TECHNICAL_DIFFICULTIES - EDGAR is experiencing technical difficulties. Consult the EDGAR News and Announcements page on SEC.gov (https://www.sec.gov/submit-filings/edgar-news-announcements) for more information. Certain submissions listed in the EDGAR Filer Manual for which transmission begins now (and is completed prior to 10 p.m.) will be treated as filed today. Other submissions will receive a filing date of the next business day.\n\nOUTSIDE_OPERATING_HOURS - EDGAR is not available because EDGAR is reporting that it is not within operating hours.\n\nNO_COMMUNICATION - EDGAR is not available for API communication due to technical difficulties or other connection issues.", "title" : "Condition" }, "message" : { "type" : "string", "examples" : [ "EDGAR is not receiving submissions until MM/DD/YYYY at HH:MM AM" ], "description" : "Optionally provides additional information if any is required", "title" : "Message" } } }, "TransmissionStatus" : { "type" : "string", "enum" : [ "RECEIVED", "REJECTED", "FAILED" ], "examples" : [ "RECEIVED", "REJECTED", "FAILED" ], "description" : "A short string that indicates the status of filing that was transmitted to EDGAR.\n* `RECEIVED` - The transmission has been received by EDGAR and an accession number has been generated\n* `REJECTED` - The transmission was rejected by EDGAR and will not be processed\n* `FAILED` - The transmission failed to be transmitted to EDGAR and will not be processed`\n", "title" : "Transmission Status" }, "SubmissionResponseItem" : { "type" : "object", "description" : "A submission response item is a one element in a submission response list.", "title" : "Submission Response Item", "properties" : { "accessionNumber" : { "type" : [ "string", "null" ], "examples" : [ "0000000001-22-000001" ], "description" : "The unique number associated with an transmitted submission.", "title" : "Accession Number" }, "messages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Message" }, "description" : "A list of messages providing details associated with the submission response. This could range from a notification about the filing to errors related to the state of the filing. This should include things like submission error codes as well as other EDGAR output.", "title" : "Messages" }, "mode" : { "$ref" : "#/components/schemas/SubmissionMode", "type" : "object" }, "final" : { "type" : "boolean" }, "transmissionStatus" : { "type" : "string", "deprecated" : true, "enum" : [ "RECEIVED", "REJECTED", "FAILED" ], "examples" : [ "RECEIVED", "REJECTED", "FAILED" ], "description" : "A short string that indicates the status of filing that was transmitted to EDGAR.\n* `RECEIVED` - The transmission has been received by EDGAR and an accession number has been generated\n* `REJECTED` - The transmission was rejected by EDGAR and will not be processed\n* `FAILED` - The transmission failed to be transmitted to EDGAR and will not be processed`\n", "title" : "Transmission Status" } } }, "IndividualInfo" : { "type" : "object", "description" : "A collection of fields pertaining to an individual", "title" : "Individual Information", "properties" : { "email" : { "type" : "string", "examples" : [ "john@doe.com" ], "description" : "Email of the individual", "title" : "Email" }, "firstName" : { "type" : "string", "examples" : [ "John" ], "description" : "First name of the individual ", "title" : "First Name" }, "middleName" : { "type" : "string", "examples" : [ "X" ], "description" : "Middle name of the individual", "title" : "Middle Name" }, "lastName" : { "type" : "string", "examples" : [ "Doe" ], "description" : "Last name of the individual", "title" : "Last Name" }, "businessPhoneNumber" : { "type" : "string", "examples" : [ "202-555-1212" ], "description" : "Business phone number of the individual", "title" : "Business Phone Number" }, "delegatedCik" : { "type" : "string", "examples" : [ "0000000000" ], "description" : "Individual's primary CIK (if any)", "title" : "Delegated CIK" }, "delegatedEntityName" : { "type" : "string", "examples" : [ "DOE Corporation" ], "description" : "Individual's primary CIK entity name (if any)", "title" : "Delegated Entity Name" }, "inAdminRole" : { "type" : "boolean", "examples" : [ true ], "description" : "Is Individual in Account Administration role", "title" : "In Account Administrator Role" }, "inTechAdminRole" : { "type" : "boolean", "examples" : [ true ], "description" : "Is Individual in Technical Administration role", "title" : "In Technical Administrator Role" }, "inUserRole" : { "type" : "boolean", "examples" : [ true ], "description" : "Is Individual in User role", "title" : "In User Role" }, "inDelegatedAdminRole" : { "type" : "boolean", "examples" : [ true ], "description" : "Is Individual in Delegated Administration role", "title" : "In Delegated Administrator Role" }, "status" : { "type" : "string", "examples" : [ "ACTIVE" ], "description" : "The status of the individual for the CIK", "title" : "Individual Status" }, "minInviteDate" : { "type" : "string", "format" : "date", "examples" : [ "2025-08-06" ], "description" : "Earliest invite date user was invited to a role (YYYY-MM-DD)", "title" : "Earliest Invite Date" }, "maxAcceptDate" : { "type" : "string", "format" : "date", "examples" : [ "2025-08-06" ], "description" : "Latest date a user can accept the invitation to a role (YYYY-MM-DD)", "title" : "Latest Accept Date" } } }, "IndividualInfoResponse" : { "type" : "object", "description" : "A filer info response is a response that encapsulates information regarding a filer", "title" : "Delegation Info Response", "properties" : { "tracking" : { "type" : "string", "description" : "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.", "title" : "Tracking Identifier" }, "locator" : { "type" : "string", "description" : "A short identifier that can be used by the EDGAR Help Desk to locate the tracking identifier within the EDGAR system.", "title" : "Tracking Locator" }, "messages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Message" }, "description" : "A list of messages providing details associated with the filer management response.", "title" : "Messages" }, "individuals" : { "type" : "array", "oneOf" : [ { "$ref" : "#/components/schemas/IndividualInfo" } ], "items" : { "$ref" : "#/components/schemas/IndividualInfo" }, "description" : "An list containing objects made up of properties related individual", "title" : "Individuals" } } }, "SubmissionType" : { "type" : "string", "enum" : [ "SINGLE", "BULK" ], "examples" : [ "SINGLE" ], "description" : "The submission type (BULK or SINGLE) of a filing", "title" : "Submission Type" }, "IndividualRole" : { "type" : "object", "description" : "Represents a request to create invites for users for a cik", "title" : "Individual Role", "properties" : { "firstName" : { "type" : "string", "description" : "String value of the individual's first name that is being invited", "title" : "First Name" }, "middleName" : { "type" : "string", "description" : "String value of the individual's middle name that is being invited", "title" : "Middle Name" }, "lastName" : { "type" : "string", "description" : "String value of the individual's last name that is being invited", "title" : "Last Name" }, "email" : { "type" : "string", "description" : "String value of the individual's email that is being invited", "title" : "Email" }, "inAdminRole" : { "type" : "boolean", "description" : "Boolean value describing if the user is going to be added to the filer administrator role'", "title" : "In Admin Role" }, "inTechAdminRole" : { "type" : "boolean", "description" : "Boolean value describing if the user is going to be added to the technical administrator role'", "title" : "In Technical Admin Role" }, "inUserRole" : { "type" : "boolean", "description" : "Boolean value describing if the user is going to be added to the user role'", "title" : "In User Role" } } }, "SingleSubmissionResponse" : { "type" : "object", "description" : "A submission response is a response to transmitting a submission.", "title" : "Submission Response", "properties" : { "tracking" : { "type" : "string", "description" : "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.", "title" : "Tracking Identifier" }, "locator" : { "type" : "string", "description" : "A short identifier that can be used by the EDGAR Help Desk to locate the tracking identifier within the EDGAR system.", "title" : "Tracking Locator" }, "accessionNumber" : { "type" : [ "string", "null" ], "examples" : [ "0000000001-22-000001" ], "description" : "The unique number associated with an transmitted submission.", "title" : "Accession Number" }, "messages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Message" }, "description" : "A list of messages providing details associated with the submission response. This could range from a notification about the filing to errors related to the state of the filing. This should include things like submission error codes as well as other EDGAR output.", "title" : "Messages" }, "mode" : { "$ref" : "#/components/schemas/SubmissionMode", "type" : "object" }, "status" : { "type" : "string", "enum" : [ "RECEIVED", "REJECTED", "FAILED" ], "examples" : [ "RECEIVED", "REJECTED", "FAILED" ], "description" : "A short string that indicates the status of filing that was transmitted to EDGAR.\n* `RECEIVED` - The transmission has been received by EDGAR and an accession number has been generated\n* `REJECTED` - The transmission was rejected by EDGAR and will not be processed\n* `FAILED` - The transmission failed to be transmitted to EDGAR and will not be processed`\n", "title" : "Transmission Status" }, "transmissionStatus" : { "type" : "string", "deprecated" : true, "enum" : [ "RECEIVED", "REJECTED", "FAILED" ], "examples" : [ "RECEIVED", "REJECTED", "FAILED" ], "description" : "A short string that indicates the status of filing that was transmitted to EDGAR.\n* `RECEIVED` - The transmission has been received by EDGAR and an accession number has been generated\n* `REJECTED` - The transmission was rejected by EDGAR and will not be processed\n* `FAILED` - The transmission failed to be transmitted to EDGAR and will not be processed`\n", "title" : "Transmission Status" } } } }, "securitySchemes" : { "Filer API Token and User API Token" : { "type" : "http", "description" : "A Filer API Token would be required to be presented to use any of the EDGAR APIs—the EDGAR Submission API, EDGAR Submission Status API, and EDGAR Operational Status API. A User API Token would be required to be presented for the EDGAR Submission API only. EDGAR submissions made using the EDGAR Submission API would be subject to the same authentication and validation procedures that apply to submissions made via the EDGAR filing websites.", "in" : "header", "scheme" : "bearer", "bearerFormat" : "JWT" }, "Filer API Token" : { "type" : "http", "description" : "A Filer API Token would be required to be presented to use any of the EDGAR APIs—the EDGAR Submission API, EDGAR Submission Status API, and EDGAR Operational Status API.", "in" : "header", "scheme" : "bearer", "bearerFormat" : "JWT" } } }, "info" : { "title" : "EDGAR API", "version" : "1.11.0" }, "servers" : [ { "url" : "https://api.edgarfiling.sec.gov", "description" : "EDGAR Operational Status API" }, { "url" : "https://api.edgarfiling.sec.gov", "description" : "EDGAR Submission API" }, { "url" : "https://api.edgarfiling.sec.gov", "description" : "EDGAR Filer Management API" } ], "tags" : [ { "name" : "EDGAR Operational Status API", "description" : "This API reports the status of the EDGAR system. This resource requires presentation of a Filer API Token only." }, { "name" : "Filer Management API", "description" : " A set of API endpoints that allows you to verify permissions, get filer information, manage CCC, manage individuals, and manage delegations.\n" }, { "name" : "Submission API", "description" : " Submission of filings to EDGAR by API can be made through the Submission API. The Submission API requires the presentation of a Filer API Token in combination with a User API Token. Optionally,\n filers could also specify a login CIK if there is a delegation from the EDGAR account corresponding to the login CIK to the filer API token EDGAR account/CIK. Delegations can be established on\n the Filer Management dashboard under “Manage Delegations and User Groups.” For more information on establishing delegations,\n see [How Do I “Understand and Manage Delegation.](https://www.sec.gov/submit-filings/filer-support-resources/how-do-i-guides/understand-manage-delegation)”\n\n Filings transmitted through the Submission API are expected to conform to the filing standard(s) [provided by the SEC](https://www.sec.gov/submit-filings).\n Information is provided on the required format and contents of filings by the [Technical Specifications](https://www.sec.gov/submit-filings/technical-specifications).\n Information and guidance on filing can be found in the [EDGAR Filing Manual](https://www.sec.gov/submit-filings/edgar-filer-manual).\n Information on specific forms can be found in the [SEC Forms Index](https://www.sec.gov/submit-filings/forms-index).\n\n The Submission API will return accession numbers for the submitted filings. A 202 HTTP status code indicates only that processing will begin in EDGAR and an\n accession number or accession numbers have been generated. Filings with errors will be processed and suspended by EDGAR. The results of processing (status and errors)\n are not provided by this endpoint and are instead available to clients using the API through the Submission Status API.\n\n When using Submission API endpoints, the client can optionally specify the \"Expect: 100-continue\" HTTP request header to allow a response from these API resources\n to be returned before uploading the entire filing in the event that the EDGAR API determines that the request will not be allowed.\n This header should only be used for requests that have a body more than 1MiB in size.\n\n Filings may be transmitted via either SINGLE or BULK transmission. A SINGLE transmission provides a single filling and will result in a response containing an accession number if the filing is transmitted successfully or an error if there is an issue while transmitting the filing. Even if a filing is successfully transmitted through the submission API, the filing may still be suspended by EDGAR if the contents of the filing do not satisfy EDGAR filing requirements. The accession number may be provided to the Submission Status API in order to check whether the filing was accepted by EDGAR.\n\n A BULK filing, in contrast, is a single document that contains multiple filings to be submitted. If one or more filings are successfully transmitted then one or more accession numbers will be created and returned in the same order filings are included in the BULK filing document. However, if a filing is not successfully transmitted then an accession number may not be created, which means that the filer may have difficulty determining which accession number corresponds to which filing in the BULK filing document. Even if a filing is successfully transmitted through the Submission API, the filing may still be suspended by EDGAR if the contents of the filing do not satisfy EDGAR filing requirements. The relevant accession number may be provided to the Submission Status API in order to check whether the filing was accepted by EDGAR.\n" }, { "name" : "Submission Status API", "description" : " The Submission Status API provides information from the EDGAR system. It requires a Filer API Token and accession number(s). To obtain information about a submission through the Submission Status API,\n you must use a Filer API Token that belongs to the CIK that submitted the filing or the CIK that was the filer for the submission. The Submission Status API will only return the detailed information about\n the filling (like error codes or the filer notification text) once the filing has reached the end of processing signified by the field 'final' being set to true.\n \n\n The statuses of filings are retained for limited amounts of time. The statuses of Accepted TEST filings are retained for two (2) days, Accepted LIVE filings are retained for sixty (60) days, and Suspended filings,\n regardless of type, are retained for six (6) days.\n" } ], "paths" : { "/fm/{cik}" : { "get" : { "summary" : "View filer account information", "description" : "The view filer account information API provides the ability to view filer information for an EDGAR account/CIK.\nThis API will require the following inputs: the filer API token, the user API token, and the EDGAR account/CIK\nfor which information is being retrieved.\nThe individual associated with the user API token must be a user, account administrator, delegated user, delegated\naccount administrator, or technical administrator of the CIK for which account information is to be viewed.\nThe filer API token supplied for the request must either match that CIK or the CIK of the filer API token must have delegation from that CIK.\n", "operationId" : "View Filer Account Information", "tags" : [ "Filer Management API" ], "parameters" : [ { "name" : "cik", "in" : "path", "required" : true, "schema" : { "type" : "string", "pattern" : "\\d{10}" } } ], "responses" : { "200" : { "description" : "OK. The request was successful.", "content" : { "application/json" : { "examples" : { "OK" : { "description" : "Details about a filer/entity (e.g., name, address, dba-name, foreign-name, etc.)", "value" : { "tracking" : "f0bd5ef3aaf666475b7b466d46120973", "locator" : "nfkkg", "messages" : [ { "type" : "INFO", "content" : "OK" } ], "filerInfo" : [ { "cik" : "0000000000", "stateCode" : "TX", "irsNumber" : "000000000", "entityType" : "A", "dateIncorporated" : "1970-01-01 00:00:00", "sicCode" : "6189", "fyEnd" : "0630", "individualOrCompany" : "C", "specialFilerType" : "string", "legalEntityIdentifier" : "ABCD123456789012", "repFileNum" : "123-123456-12", "dateModified" : "2024-01-01T12:00:00Z", "entityName" : "Filers Inc", "entityDbaName" : "string", "entityForeignName" : "string", "mailIsForeignAddress" : "false", "mailStreet1" : "123 Broadway", "mailStreet2" : "Suite 200", "mailCity" : "Dallas", "mailStateCode" : "K3", "mailForeignState" : "Maharashtra", "mailZip" : "75240", "businessIsForeignAddress" : false, "businessStreet1" : "123 Broadway", "businessStreet2" : "Suite 200", "businessCity" : "Dallas", "businessStateCode" : "TX", "businessForeignState" : null, "businessZip" : "75240", "peoStreet1" : "string", "peoStreet2" : "string", "peoCity" : "string", "peoStateCode" : "string", "peoZip" : "string", "acctName" : "Chris", "acctPhone" : "555-555-5555", "acctStreet1" : "123 MAIN ST. - BILLING", "acctStreet2" : null, "acctCity" : "ANYTOWN", "acctStateCode" : "TX", "acctZip" : "12345", "acctEmail" : "chris@somecompany.com", "contName" : "James Smith", "contPhone" : "555-555-5555", "contEmail" : "james@somecopany.com", "mailingPhone" : "555-555-5555", "businessPhone" : "555-555-5555", "ccc" : "@1B2C3d4", "confirmationDueDate" : "Date", "singleEntityCompany" : "false", "website" : "www.somecompany.com", "series" : [ ] } ] } } }, "schema" : { "$ref" : "#/components/schemas/FilerInfoResponse" } } } }, "400" : { "description" : "Bad request. The request was not successful, possibly due to invalid data", "content" : { "application/json" : { "examples" : { "Bad request" : { "description" : "Input error (invalid data)", "value" : { "tracking" : "c209d91efee936e1d315d868f06f763d", "locator" : "47a94d", "messages" : [ { "type" : "ERROR", "message" : "Invalid data" } ] } } }, "schema" : { "$ref" : "#/components/schemas/IndividualInfoResponse" } } } }, "401" : { "description" : "Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.", "content" : { "application/json" : { "examples" : { "Unauthorized" : { "description" : "The request does not include any valid tokens for accessing this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Unauthorized" } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "403" : { "description" : "Forbidden. A valid Filer API Token and User Access Token must be provided with this request. Please ensure that the User identified by the User Access Token is authorized to perform the action.", "content" : { "application/json" : { "examples" : { "Forbidden" : { "description" : "The request had included valid tokens but that does not give access to this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Forbidden." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "500" : { "description" : "Server error. An unexpected server-side error has occurred.", "content" : { "application/json" : { "examples" : { "Internal server error" : { "description" : "An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "An unexpected error has occurred." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "security" : [ { "Filer API Token and User API Token" : [ ] } ], "servers" : [ { "url" : "https://api.edgarfiling.sec.gov", "description" : "EDGAR Filer Management API" } ] } }, "/fm/{cik}/ccc" : { "post" : { "summary" : "Generate CCC", "description" : "The generate CCC API allows a filer to have EDGAR randomly generate a new CCC for the filer. This API will require the filer API token, the user API token,\nand the CIK of the EDGAR account for which the CCC will be generated. The individual associated with the user API token must be\nan account administrator of the EDGAR account/CIK for which the CCC is to be generated. The filer API token supplied for the request\nmust either match the CIK of the EDGAR account for which the CCC is to be generated or the CIK of the filer API token must have\ndelegation from that CIK.\n", "operationId" : "Generate CCC", "tags" : [ "Filer Management API" ], "parameters" : [ { "name" : "cik", "in" : "path", "required" : true, "schema" : { "type" : "string", "pattern" : "\\d{10}" } } ], "responses" : { "200" : { "description" : "OK. The request was successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FilerCCCResponse" } } } }, "400" : { "description" : "Bad request. The request was not successful, possibly due to invalid data", "content" : { "application/json" : { "examples" : { "Bad request" : { "description" : "Input error (invalid data)", "value" : { "tracking" : "c209d91efee936e1d315d868f06f763d", "locator" : "47a94d", "messages" : [ { "type" : "ERROR", "message" : "Invalid data" } ] } } }, "schema" : { "$ref" : "#/components/schemas/IndividualInfoResponse" } } } }, "401" : { "description" : "Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.", "content" : { "application/json" : { "examples" : { "Unauthorized" : { "description" : "The request does not include any valid tokens for accessing this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Unauthorized" } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "403" : { "description" : "Forbidden. A valid Filer API Token and User Access Token must be provided with this request. Please ensure that the User identified by the User Access Token is authorized to perform the action.", "content" : { "application/json" : { "examples" : { "Forbidden" : { "description" : "The request had included valid tokens but that does not give access to this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Forbidden." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "500" : { "description" : "Server error. An unexpected server-side error has occurred.", "content" : { "application/json" : { "examples" : { "Internal server error" : { "description" : "An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "An unexpected error has occurred." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "security" : [ { "Filer API Token and User API Token" : [ ] } ], "servers" : [ { "url" : "https://api.edgarfiling.sec.gov", "description" : "EDGAR Filer Management API" } ] }, "put" : { "summary" : "Create custom CCC", "description" : "The create custom CCC API allows a filer to specify a new CCC. The API will require the following inputs: the filer API token, the user API token,\nthe CIK of the EDGAR account for which the custom CCC will be created, the current CCC, and the new CCC. The individual associated with\nthe user API token must be an account administrator of the EDGAR account/CIK for which the CCC is to be changed. The filer API token supplied for\nthe request must either match the CIK for which the CCC is to be changed or the CIK of the filer API token must have delegation from that CIK.\n", "operationId" : "Create Custom CCC", "tags" : [ "Filer Management API" ], "parameters" : [ { "name" : "cik", "in" : "path", "required" : true, "schema" : { "type" : "string", "pattern" : "\\d{10}" } } ], "requestBody" : { "description" : "Update CCC object (Current CCC, Replacement CCC)", "content" : { "application/json" : { "examples" : { "Update CCC" : { "summary" : "Update CCC", "description" : "Update CCC", "value" : { "currentCCC" : "xxxxxxxx", "replacementCCC" : "yyyyyyyy" } } }, "schema" : { "$ref" : "#/components/schemas/UpdateCCC" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK. The request was successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FilerCCCResponse" } } } }, "400" : { "description" : "Bad request. The request was not successful, possibly due to invalid data", "content" : { "application/json" : { "examples" : { "Bad request" : { "description" : "Input error (invalid data)", "value" : { "tracking" : "c209d91efee936e1d315d868f06f763d", "locator" : "47a94d", "messages" : [ { "type" : "ERROR", "message" : "Invalid data" } ] } } }, "schema" : { "$ref" : "#/components/schemas/IndividualInfoResponse" } } } }, "401" : { "description" : "Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.", "content" : { "application/json" : { "examples" : { "Unauthorized" : { "description" : "The request does not include any valid tokens for accessing this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Unauthorized" } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "403" : { "description" : "Forbidden. A valid Filer API Token and User Access Token must be provided with this request. Please ensure that the User identified by the User Access Token is authorized to perform the action.", "content" : { "application/json" : { "examples" : { "Forbidden" : { "description" : "The request had included valid tokens but that does not give access to this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Forbidden." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "500" : { "description" : "Server error. An unexpected server-side error has occurred.", "content" : { "application/json" : { "examples" : { "Internal server error" : { "description" : "An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "An unexpected error has occurred." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "security" : [ { "Filer API Token and User API Token" : [ ] } ], "servers" : [ { "url" : "https://api.edgarfiling.sec.gov", "description" : "EDGAR Filer Management API" } ] } }, "/fm/{cik}/delegationRequests" : { "post" : { "summary" : "Request delegation invitations", "description" : "The request delegation invitations API provides the ability for an EDGAR account (for example, a filing agent) to request delegation from one\nor more filers. If a filer accepts the delegation request, a delegation invitation will be sent from the filer to the EDGAR account requesting\ndelegation. If the delegation invitation is accepted by the EDGAR account requesting delegation, that EDGAR account will become a delegated\nentity that can submit filings on behalf of the filer. This API will require the following inputs: the filer API token, the user API token,\nthe CIK belonging to the requesting EDGAR account that would like to become a delegated entity, and CIK(s) that will receive the delegation\nrequest. The individual associated with the user API token must be an account administrator of the CIK requesting a delegation invitation.\nThe filer API token supplied for the request must match the CIK requesting a delegation invitation.\n", "operationId" : "Request Delegation Invitations", "tags" : [ "Filer Management API" ], "parameters" : [ { "name" : "cik", "in" : "path", "required" : true, "schema" : { "type" : "string", "pattern" : "\\d{10}" } } ], "requestBody" : { "description" : "List of delegation request filer/entity CIKs", "content" : { "application/json" : { "examples" : { "Delegation request to single CIK" : { "summary" : "Delegation request single CIK", "description" : "Delegation request to single CIK", "value" : [ "0000000001" ] }, "Delegation request to multiple CIKs" : { "summary" : "Delegation request to multiple CIKs", "description" : "Delegation request to multiple CIKs", "value" : [ "0000000001", "0000000002" ] } }, "schema" : { "type" : "array", "items" : { "type" : "string" } } } }, "required" : true }, "responses" : { "200" : { "description" : "OK. The request was successful.", "content" : { "application/json" : { "examples" : { "OK" : { "description" : "ADD DELEGATION REQUESTS OK description", "value" : { "tracking" : "c209d91efee936e1d315d868f06f763d", "locator" : "47a94d", "messages" : [ { "type" : "INFO", "message" : "<>" } ] } } }, "schema" : { "$ref" : "#/components/schemas/FilerInfoResponse" } } } }, "400" : { "description" : "Bad request. The request was not successful, possibly due to invalid data", "content" : { "application/json" : { "examples" : { "Bad request" : { "description" : "Input error (invalid data)", "value" : { "tracking" : "c209d91efee936e1d315d868f06f763d", "locator" : "47a94d", "messages" : [ { "type" : "ERROR", "message" : "Invalid data" } ] } } }, "schema" : { "$ref" : "#/components/schemas/IndividualInfoResponse" } } } }, "401" : { "description" : "Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.", "content" : { "application/json" : { "examples" : { "Unauthorized" : { "description" : "The request does not include any valid tokens for accessing this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Unauthorized" } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "403" : { "description" : "Forbidden. A valid Filer API Token and User Access Token must be provided with this request. Please ensure that the User identified by the User Access Token is authorized to perform the action.", "content" : { "application/json" : { "examples" : { "Forbidden" : { "description" : "The request had included valid tokens but that does not give access to this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Forbidden." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "500" : { "description" : "Server error. An unexpected server-side error has occurred.", "content" : { "application/json" : { "examples" : { "Internal server error" : { "description" : "An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "An unexpected error has occurred." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "security" : [ { "Filer API Token and User API Token" : [ ] } ], "servers" : [ { "url" : "https://api.edgarfiling.sec.gov", "description" : "EDGAR Filer Management API" } ] } }, "/fm/{cik}/delegations" : { "post" : { "summary" : "Send delegation invitations", "description" : "The send delegation invitations API provides the ability for a filer to delegate to one or more EDGAR accounts. If those EDGAR accounts accept\nthe delegation invitation, those EDGAR accounts will become delegated entities who can submit filings on behalf of the delegating filer.\nThis API will require the following inputs: the filer API token, the user API token, the delegating filer’s CIK, and a list of one or more\ndelegated entity CIKs that will receive the delegation invitation. The individual associated with the user API token must be an account\nadministrator of the CIK from which delegation invitations are to be sent. The filer API token supplied for the request must match that CIK.\n", "operationId" : "Send Delegation Invitations", "tags" : [ "Filer Management API" ], "parameters" : [ { "name" : "cik", "in" : "path", "required" : true, "schema" : { "type" : "string", "pattern" : "\\d{10}" } } ], "requestBody" : { "description" : "List of delegation filer/entity CIKs", "content" : { "application/json" : { "examples" : { "Delegate to single CIK" : { "summary" : "Delegate to single CIK", "description" : "Delegate to single CIK", "value" : [ "0000000001" ] }, "Delegate to multiple CIKs" : { "summary" : "Delegate to multiple CIKs", "description" : "Delegate to multiple CIKs", "value" : [ "0000000001", "0000000002" ] } }, "schema" : { "type" : "array", "items" : { "type" : "string" } } } }, "required" : true }, "responses" : { "200" : { "description" : "OK. The request was successful.", "content" : { "application/json" : { "examples" : { "OK" : { "description" : "ADD DELEGATIONS OK description", "value" : { "tracking" : "c209d91efee936e1d315d868f06f763d", "locator" : "47a94d", "responses" : [ ], "messages" : [ { "type" : "INFO", "message" : "<>" } ] } } }, "schema" : { "$ref" : "#/components/schemas/FilerInfoResponse" } } } }, "400" : { "description" : "Bad request. The request was not successful, possibly due to invalid data", "content" : { "application/json" : { "examples" : { "Bad request" : { "description" : "Input error (invalid data)", "value" : { "tracking" : "c209d91efee936e1d315d868f06f763d", "locator" : "47a94d", "messages" : [ { "type" : "ERROR", "message" : "Invalid data" } ] } } }, "schema" : { "$ref" : "#/components/schemas/IndividualInfoResponse" } } } }, "401" : { "description" : "Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.", "content" : { "application/json" : { "examples" : { "Unauthorized" : { "description" : "The request does not include any valid tokens for accessing this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Unauthorized" } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "403" : { "description" : "Forbidden. A valid Filer API Token and User Access Token must be provided with this request. Please ensure that the User identified by the User Access Token is authorized to perform the action.", "content" : { "application/json" : { "examples" : { "Forbidden" : { "description" : "The request had included valid tokens but that does not give access to this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Forbidden." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "500" : { "description" : "Server error. An unexpected server-side error has occurred.", "content" : { "application/json" : { "examples" : { "Internal server error" : { "description" : "An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "An unexpected error has occurred." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "security" : [ { "Filer API Token and User API Token" : [ ] } ], "servers" : [ { "url" : "https://api.edgarfiling.sec.gov", "description" : "EDGAR Filer Management API" } ] }, "get" : { "summary" : "View delegations", "description" : "The view delegations API provides the ability for a filer/EDGAR account to retrieve a list of all its delegations to and from other\nEDGAR accounts/CIKs. This API will require the following inputs: the filer API token, the user API token, and the EDGAR account/CIK\nfor which delegation information is to be retrieved. The individual associated with the user API token must be a user or an account\nadministrator of the CIK for which delegation information is to be retrieved. The filer API token supplied for the request must match that CIK.\n", "operationId" : "View Delegations", "tags" : [ "Filer Management API" ], "parameters" : [ { "name" : "cik", "in" : "path", "required" : true, "schema" : { "type" : "string", "pattern" : "\\d{10}" } } ], "responses" : { "200" : { "description" : "OK. The request was successful.", "content" : { "application/json" : { "examples" : { "OK" : { "description" : "GET DELEGATIONS OK description", "value" : { "tracking" : "c209d91efee936e1d315d868f06f763d", "locator" : "47a94d", "delegationsTo" : [ ], "delegationsFrom" : [ ], "messages" : [ { "type" : "INFO", "message" : "OK" } ] } } }, "schema" : { "$ref" : "#/components/schemas/DelegationInfoResponse" } } } }, "401" : { "description" : "Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.", "content" : { "application/json" : { "examples" : { "Unauthorized" : { "description" : "The request does not include any valid tokens for accessing this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Unauthorized" } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "403" : { "description" : "Forbidden. A valid Filer API Token and User Access Token must be provided with this request. Please ensure that the User identified by the User Access Token is authorized to perform the action.", "content" : { "application/json" : { "examples" : { "Forbidden" : { "description" : "The request had included valid tokens but that does not give access to this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Forbidden." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "500" : { "description" : "Server error. An unexpected server-side error has occurred.", "content" : { "application/json" : { "examples" : { "Internal server error" : { "description" : "An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "An unexpected error has occurred." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "security" : [ { "Filer API Token and User API Token" : [ ] } ], "servers" : [ { "url" : "https://api.edgarfiling.sec.gov", "description" : "EDGAR Filer Management API" } ] } }, "/fm/{cik}/individuals" : { "post" : { "summary" : "Add individuals", "description" : "The add individuals API allows for one or more individuals to be added in specific role(s) for a filer. This API will require the following\ninputs: the filer API token, the user API token, the EDGAR account CIK for which individuals are to be added, a list of individuals\n(identified by their names and Login.gov email addresses), and their new roles. The individual associated with the user API token must be\nan account administrator of the CIK for which individuals are to be added. The filer API token supplied for the request must either match\nthe CIK for which individuals are to be added or the CIK of the filer API token must have delegation from that CIK.\n", "operationId" : "Add Individuals", "tags" : [ "Filer Management API" ], "parameters" : [ { "name" : "cik", "in" : "path", "required" : true, "schema" : { "type" : "string", "pattern" : "\\d{10}" } } ], "requestBody" : { "description" : "List of individuals and associated roles", "content" : { "application/json" : { "examples" : { "Add Single Individual" : { "summary" : "Single individual (with email, first name, middle name, last name) and related roles", "description" : "Single individual (with email, first name, middle name, last name) and related roles", "value" : [ { "email" : "barry.allen@flash.com", "firstName" : "Bartholomew", "middleName" : "Henry", "lastName" : "Allen", "inAdminRole" : false, "inTechAdminRole" : true, "inUserRole" : true } ] }, "Add Multiple Individuals" : { "summary" : "Multiple individuals (with email, first name, middle name, last name) and related roles", "description" : "Multiple individuals (with email, first name, middle name, last name) and related roles", "value" : [ { "email" : "money.penny@007.com", "firstName" : "Money", "lastName" : "Penny", "inAdminRole" : true, "inTechAdminRole" : true, "inUserRole" : false }, { "email" : "barry.allen@flash.com", "firstName" : "Bartholomew", "middleName" : "Henry", "lastName" : "Allen", "inAdminRole" : false, "inTechAdminRole" : true, "inUserRole" : true } ] } }, "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IndividualRole" } } } }, "required" : true }, "responses" : { "200" : { "description" : "OK. The request was successful.", "content" : { "application/json" : { "examples" : { "OK" : { "description" : "ADD INDIVIDUALS OK DESCRIPTION", "value" : { "tracking" : "c209d91efee936e1d315d868f06f763d", "locator" : "47a94d", "responses" : [ ], "messages" : [ { "type" : "INFO", "message" : "Invite(s) created." } ] } } }, "schema" : { "$ref" : "#/components/schemas/FilerInfoResponse" } } } }, "400" : { "description" : "Bad request. The request was not successful, possibly due to invalid data", "content" : { "application/json" : { "examples" : { "Bad request" : { "description" : "Input error (invalid data)", "value" : { "tracking" : "c209d91efee936e1d315d868f06f763d", "locator" : "47a94d", "messages" : [ { "type" : "ERROR", "message" : "Invalid data" } ] } } }, "schema" : { "$ref" : "#/components/schemas/IndividualInfoResponse" } } } }, "401" : { "description" : "Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.", "content" : { "application/json" : { "examples" : { "Unauthorized" : { "description" : "The request does not include any valid tokens for accessing this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Unauthorized" } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "403" : { "description" : "Forbidden. A valid Filer API Token and User Access Token must be provided with this request. Please ensure that the User identified by the User Access Token is authorized to perform the action.", "content" : { "application/json" : { "examples" : { "Forbidden" : { "description" : "The request had included valid tokens but that does not give access to this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Forbidden." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "500" : { "description" : "Server error. An unexpected server-side error has occurred.", "content" : { "application/json" : { "examples" : { "Internal server error" : { "description" : "An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "An unexpected error has occurred." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "security" : [ { "Filer API Token and User API Token" : [ ] } ], "servers" : [ { "url" : "https://api.edgarfiling.sec.gov", "description" : "EDGAR Filer Management API" } ] }, "get" : { "summary" : "View individuals", "description" : "The view individuals API provides the ability to view all individuals with a role for an EDGAR account/CIK. This API will require the following\ninputs: the filer API token, the user API token, and the CIK for which individuals are to be viewed. The individual associated with the user\nAPI token must be an account administrator of the CIK for which individuals are to be viewed. The filer API token supplied for the request must\neither match the CIK for which individuals are to be viewed or the CIK of the filer API token must have delegation from that CIK.\n", "operationId" : "View Individuals", "tags" : [ "Filer Management API" ], "parameters" : [ { "name" : "cik", "in" : "path", "required" : true, "schema" : { "type" : "string", "pattern" : "\\d{10}" } } ], "responses" : { "200" : { "description" : "OK. The request was successful.", "content" : { "application/json" : { "examples" : { "OK" : { "description" : "GET INDIVIDUALS OK description", "value" : { "tracking" : "c209d91efee936e1d315d868f06f763d", "locator" : "47a94d", "individuals" : [ ], "messages" : [ { "type" : "INFO", "message" : "OK" } ] } } }, "schema" : { "$ref" : "#/components/schemas/IndividualInfoResponse" } } } }, "401" : { "description" : "Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.", "content" : { "application/json" : { "examples" : { "Unauthorized" : { "description" : "The request does not include any valid tokens for accessing this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Unauthorized" } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "403" : { "description" : "Forbidden. A valid Filer API Token and User Access Token must be provided with this request. Please ensure that the User identified by the User Access Token is authorized to perform the action.", "content" : { "application/json" : { "examples" : { "Forbidden" : { "description" : "The request had included valid tokens but that does not give access to this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Forbidden." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "500" : { "description" : "Server error. An unexpected server-side error has occurred.", "content" : { "application/json" : { "examples" : { "Internal server error" : { "description" : "An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "An unexpected error has occurred." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "security" : [ { "Filer API Token and User API Token" : [ ] } ], "servers" : [ { "url" : "https://api.edgarfiling.sec.gov", "description" : "EDGAR Filer Management API" } ] }, "put" : { "summary" : "Change roles", "description" : "The change roles API provides the ability to update roles for individuals for a CIK. This API will require the following inputs: the filer API\ntoken, the user API token, the EDGAR account CIK for which roles are to be changed, a list of the individuals (identified by their Login.gov\nemail addresses), and their new roles (updated roles). The individual associated with the user API token must be an account administrator of\nthe CIK for which roles are to be changed. The filer API token supplied for the request must either match the CIK for which roles are to be\nchanged or the CIK of the filer API token must have delegation from that CIK.\n", "operationId" : "Change Roles", "tags" : [ "Filer Management API" ], "parameters" : [ { "name" : "cik", "in" : "path", "required" : true, "schema" : { "type" : "string", "pattern" : "\\d{10}" } } ], "requestBody" : { "description" : "List of emails and related roles for updating individual roles", "content" : { "application/json" : { "examples" : { "Update role for single individual" : { "summary" : "Update role for single individual (email and related roles)", "description" : "Update role for single individual (email and related roles)", "value" : [ { "email" : "money.penny@007.com", "inAdminRole" : false, "inTechAdminRole" : false, "inUserRole" : true } ] }, "Update role for multiple individuals" : { "summary" : "Update role for multiple individuals (email and related roles)", "description" : "Update role for multiple individuals (email and related roles)", "value" : [ { "email" : "money.penny@007.com", "inAdminRole" : false, "inTechAdminRole" : false, "inUserRole" : true }, { "email" : "barry.allen@flash.com", "inAdminRole" : true, "inTechAdminRole" : false, "inUserRole" : false } ] } }, "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EmailRole" } } } }, "required" : true }, "responses" : { "200" : { "description" : "OK. The request was successful.", "content" : { "application/json" : { "examples" : { "OK" : { "description" : "UPDATE INDIVIDUAL ROLES OK DESCRIPTION", "value" : { "tracking" : "c209d91efee936e1d315d868f06f763d", "locator" : "47a94d", "messages" : [ { "type" : "INFO", "message" : "<>" } ] } } }, "schema" : { "$ref" : "#/components/schemas/FilerInfoResponse" } } } }, "400" : { "description" : "Bad request. The request was not successful, possibly due to invalid data", "content" : { "application/json" : { "examples" : { "Bad request" : { "description" : "Input error (invalid data)", "value" : { "tracking" : "c209d91efee936e1d315d868f06f763d", "locator" : "47a94d", "messages" : [ { "type" : "ERROR", "message" : "Invalid data" } ] } } }, "schema" : { "$ref" : "#/components/schemas/IndividualInfoResponse" } } } }, "401" : { "description" : "Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.", "content" : { "application/json" : { "examples" : { "Unauthorized" : { "description" : "The request does not include any valid tokens for accessing this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Unauthorized" } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "403" : { "description" : "Forbidden. A valid Filer API Token and User Access Token must be provided with this request. Please ensure that the User identified by the User Access Token is authorized to perform the action.", "content" : { "application/json" : { "examples" : { "Forbidden" : { "description" : "The request had included valid tokens but that does not give access to this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Forbidden." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "500" : { "description" : "Server error. An unexpected server-side error has occurred.", "content" : { "application/json" : { "examples" : { "Internal server error" : { "description" : "An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "An unexpected error has occurred." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "security" : [ { "Filer API Token and User API Token" : [ ] } ], "servers" : [ { "url" : "https://api.edgarfiling.sec.gov", "description" : "EDGAR Filer Management API" } ] }, "delete" : { "summary" : "Remove individuals", "description" : "The remove individuals API provides the ability to remove one or more individuals. This API will require the following inputs: the filer API\ntoken, the user API token, the EDGAR account CIK for which individuals are to be removed, a list of individuals (identified by their\nLogin.gov email addresses), and their roles to be removed. The individual associated with the user API token must be an account administrator\nof the CIK for which individuals are to be removed. The filer API token supplied for the request must either match the CIK for which individuals\nare to be removed or the CIK of the filer API token must have delegation from that CIK.\n", "operationId" : "Remove Individuals", "tags" : [ "Filer Management API" ], "parameters" : [ { "name" : "cik", "in" : "path", "required" : true, "schema" : { "type" : "string", "pattern" : "\\d{10}" } } ], "requestBody" : { "description" : "List of emails of individuals for removal", "content" : { "application/json" : { "examples" : { "Remove single individual" : { "summary" : "Remove single individual (email)", "description" : "Remove single individual (email)", "value" : [ "money.penny@007.com" ] }, "Remove multiple individuals" : { "summary" : "Remove multiple individuals (email)", "description" : "Remove multiple individuals (email)", "value" : [ "money.penny@007.com", "barry.allen@flash.com" ] } }, "schema" : { "type" : "array", "items" : { "type" : "string" } } } }, "required" : true }, "responses" : { "200" : { "description" : "OK. The request was successful.", "content" : { "application/json" : { "examples" : { "OK" : { "description" : "REMOVE INDIVIDUALS OK DESCRIPTION", "value" : { "tracking" : "c209d91efee936e1d315d868f06f763d", "locator" : "47a94d", "messages" : [ { "type" : "INFO", "message" : "<>" } ] } } }, "schema" : { "$ref" : "#/components/schemas/FilerInfoResponse" } } } }, "400" : { "description" : "Bad request. The request was not successful, possibly due to invalid data", "content" : { "application/json" : { "examples" : { "Bad request" : { "description" : "Input error (invalid data)", "value" : { "tracking" : "c209d91efee936e1d315d868f06f763d", "locator" : "47a94d", "messages" : [ { "type" : "ERROR", "message" : "Invalid data" } ] } } }, "schema" : { "$ref" : "#/components/schemas/IndividualInfoResponse" } } } }, "401" : { "description" : "Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.", "content" : { "application/json" : { "examples" : { "Unauthorized" : { "description" : "The request does not include any valid tokens for accessing this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Unauthorized" } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "403" : { "description" : "Forbidden. A valid Filer API Token and User Access Token must be provided with this request. Please ensure that the User identified by the User Access Token is authorized to perform the action.", "content" : { "application/json" : { "examples" : { "Forbidden" : { "description" : "The request had included valid tokens but that does not give access to this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Forbidden." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "500" : { "description" : "Server error. An unexpected server-side error has occurred.", "content" : { "application/json" : { "examples" : { "Internal server error" : { "description" : "An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "An unexpected error has occurred." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "security" : [ { "Filer API Token and User API Token" : [ ] } ], "servers" : [ { "url" : "https://api.edgarfiling.sec.gov", "description" : "EDGAR Filer Management API" } ] } }, "/fm/{cik}/verify" : { "get" : { "summary" : "Filing credentials verification", "description" : "The filing credentials verification API provides the ability to view filing credentials for an EDGAR account/CIK. The API GET method requires\nthe filer API token and the user API token in the header along with the relevant CIK in the path of the URL. The individual associated with\nthe user API token must be a user, account administrator, delegated user, or delegated account administrator of the CIK for which the filing\ncredentials are to be verified. The filer API token supplied for the request must either match the CIK for which filing\ncredentials are to be verified or the CIK of the filer API token must have delegation from that CIK.\n", "operationId" : "Filing Credentials Verification", "tags" : [ "Filer Management API" ], "parameters" : [ { "name" : "cik", "in" : "path", "required" : true, "schema" : { "type" : "string", "pattern" : "\\d{10}" } } ], "responses" : { "200" : { "description" : "OK. The request was successful.", "content" : { "application/json" : { "examples" : { "OK - Can file" : { "summary" : "OK - Can file", "description" : "Individual can file.", "value" : { "tracking" : "8bdd9ff5f82da173d41bf1ed03a80af4", "locator" : "47a94d", "messages" : [ { "type" : "INFO", "content" : "OK" } ], "canFile" : false } }, "OK - Cannot file" : { "summary" : "OK - Cannot file ", "description" : "Individual cannot file", "value" : { "tracking" : "8bdd9ff5f82da173d41bf1ed03a80af4", "locator" : "47a94d", "messages" : [ { "type" : "INFO", "content" : "OK" } ], "canFile" : false } } }, "schema" : { "$ref" : "#/components/schemas/FilerCheckResponse" } } } }, "401" : { "description" : "Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.", "content" : { "application/json" : { "examples" : { "Unauthorized" : { "description" : "The request does not include any valid tokens for accessing this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Unauthorized" } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "500" : { "description" : "Server error. An unexpected server-side error has occurred.", "content" : { "application/json" : { "examples" : { "Internal server error" : { "description" : "An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "An unexpected error has occurred." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "security" : [ { "Filer API Token and User API Token" : [ ] } ], "servers" : [ { "url" : "https://api.edgarfiling.sec.gov", "description" : "EDGAR Filer Management API" } ] } }, "/status" : { "get" : { "summary" : "EDGAR System Status", "description" : "Uses EDGAR operating hours logic and communicates with other EDGAR components to determine the ability of the system to receive API calls and submissions.", "operationId" : "EDGAR System Status", "tags" : [ "EDGAR Operational Status API" ], "responses" : { "200" : { "description" : "Ok. The EDGAR system was able to provide a status response.", "content" : { "application/json" : { "examples" : { "Accepting submissions" : { "description" : "EDGAR is available because EDGAR is reporting that it is operational and within operating hours.", "value" : { "tracking" : "6345f99403f9c8014e4332a8cba2c5a6", "locator" : "l33922", "message" : "EDGAR is available because EDGAR is reporting that it is operational and within operating hours.", "condition" : "ACCEPTING" } }, "Accepting submissions with technical difficulties" : { "description" : "EDGAR is experiencing technical difficulties. Consult the EDGAR News and Announcements page on SEC.gov (https://www.sec.gov/submit-filings/edgar-news-announcements) for more information.", "value" : { "tracking" : "6345f99403f9c8014e4332a8cba2c5a6", "locator" : "l33922", "message" : "EDGAR is experiencing technical difficulties. Consult the EDGAR News and Announcements page on SEC.gov (https://www.sec.gov/submit-filings/edgar-news-announcements) for more information.", "condition" : "ACCEPTING_WITH_TECHNICAL_DIFFICULTIES" } }, "Accepting submissions after hours" : { "description" : "EDGAR is operating normally. Certain submissions listed in the EDGAR Filer Manual for which transmission begins now (and is completed prior to 10 p.m.) will be treated as filed today. Other submissions will receive a filing date of the next business day.", "value" : { "tracking" : "6345f99403f9c8014e4332a8cba2c5a6", "locator" : "l33922", "message" : "EDGAR is operating normally. Certain submissions listed in the EDGAR Filer Manual for which transmission begins now (and is completed prior to 10 p.m.) will be treated as filed today. Other submissions will receive a filing date of the next business day.", "condition" : "ACCEPTING_AFTER_HOURS" } }, "Accepting submissions after hours with technical difficulties" : { "description" : "\"EDGAR is experiencing technical difficulties. Consult the EDGAR News and Announcements page on SEC.gov (https://www.sec.gov/submit-filings/edgar-news-announcements) for more information. Certain submissions listed in the EDGAR Filer Manual for which transmission begins now (and is completed prior to 10 p.m.) will be treated as filed today. Other submissions will receive a filing date of the next business day.", "value" : { "tracking" : "6345f99403f9c8014e4332a8cba2c5a6", "locator" : "l33922", "message" : "EDGAR is experiencing technical difficulties. Consult the EDGAR News and Announcements page on SEC.gov (https://www.sec.gov/submit-filings/edgar-news-announcements) for more information. Certain submissions listed in the EDGAR Filer Manual for which transmission begins now (and is completed prior to 10 p.m.) will be treated as filed today. Other submissions will receive a filing date of the next business day.", "condition" : "ACCEPTING_AFTER_HOURS_WITH_TECHNICAL_DIFFICULTIES" } }, "Outside hours of operation" : { "description" : "EDGAR is not available because EDGAR is reporting that it is not within operating hours.", "value" : { "tracking" : "8bdd9ff5f82da173d41bf1ed03a80af4", "locator" : "l33922", "message" : "EDGAR is not available because EDGAR is reporting that it is not within operating hours.", "condition" : "OUTSIDE_OPERATING_HOURS" } }, "No communication" : { "description" : "EDGAR is not available for API communication due to technical difficulties or other connection issues.", "value" : { "tracking" : "5e981101d4bfdee09b95c6f1d53e8551", "locator" : "l33922", "message" : "EDGAR is not available for API communication due to technical difficulties or other connection issues.", "condition" : "NO_COMMUNICATION" } } }, "schema" : { "$ref" : "#/components/schemas/Response" } } } }, "401" : { "description" : "Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.", "content" : { "application/json" : { "examples" : { "Unauthorized" : { "description" : "The request does not include any valid tokens for accessing this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Unauthorized" } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "403" : { "description" : "Forbidden. This resource requires a valid Filer API Token. Please ensure that the token that is being used is a Filer API Token and is active in Filer Management.", "content" : { "application/json" : { "examples" : { "Forbidden" : { "description" : "The request has included at least one valid token but that token do not give access to this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Forbidden." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "500" : { "description" : "Server error. An unexpected server-side error has occurred.", "content" : { "application/json" : { "examples" : { "Server Error" : { "description" : "An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "An unexpected error has occurred." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "security" : [ { "Filer API Token" : [ ] } ], "servers" : [ { "url" : "https://api.edgarfiling.sec.gov", "description" : "EDGAR Operational Status API" } ] } }, "/submission/bulk/live" : { "post" : { "summary" : "Bulk Live Submission", "description" : "Allows an authorized filer to transmit a BULK LIVE 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.", "operationId" : "Bulk Live Submission", "tags" : [ "Submission API" ], "parameters" : [ { "deprecated" : true, "description" : "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.", "examples" : { "None" : { }, "Example CIK" : { "value" : "0000350001" } }, "in" : "header", "name" : "X-EDGAR-CIK", "schema" : { "type" : "string" } }, { "description" : "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.", "examples" : { "None" : { }, "Example CIK" : { "value" : "0000350001" } }, "in" : "header", "name" : "X-EDGAR-LOGIN-CIK", "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "A bulk live submission, in XML format, that will be transmitted to EDGAR and processed.", "content" : { "application/octet-stream" : { "examples" : { "Bulk Live Submission" : { "description" : "A valid bulk live submission", "value" : "\n\n LIVE\n \n \n S-1.xml\n PD94bWwgdmVyc2lvbj0iMS4wIiA/Pjxjb3I6ZWRnYXJTdWJtaXNzaW9uIHhtbG5zOmNvcj0iaHR0\ncDovL3d3dy5zZWMuZ292L2VkZ2FyL2NvcmVnZmVlIiB4bWxuczpjb209Imh0dHA6Ly93d3cuc2Vj\nLmdvdi9lZGdhci9jb21tb24iIHhtbG5zOmZlZWM9Imh0dHA6Ly93d3cuc2VjLmdvdi9lZGdhci9m\nZWVjb21tb24iPgogIDxjb3I6bGl2ZVRlc3RGbGFnPkxJVkU8L2NvcjpsaXZlVGVzdEZsYWc+CiAg\nPGNvcjpmbGFncz4KICAgIDxjb3I6Y29uZmlybWluZ0NvcHlGbGFnPmZhbHNlPC9jb3I6Y29uZmly\nbWluZ0NvcHlGbGFnPgogICAgPGNvcjpkZWxheWluZ0FtZW5kbWVudEZsYWc+ZmFsc2U8L2Nvcjpk\nZWxheWluZ0FtZW5kbWVudEZsYWc+CiAgICA8Y29yOm92ZXJyaWRlSW50ZXJuZXRGbGFnPmZhbHNl\nPC9jb3I6b3ZlcnJpZGVJbnRlcm5ldEZsYWc+CiAgICA8Y29yOnJldHVybkNvcHlGbGFnPmZhbHNl\nPC9jb3I6cmV0dXJuQ29weUZsYWc+CiAgPC9jb3I6ZmxhZ3M+CiAgPGNvcjpzdWJtaXNzaW9uVHlw\nZT5TLTE8L2NvcjpzdWJtaXNzaW9uVHlwZT4KICA8Y29yOmZpbGVyPgogICAgPGNvcjpmaWxlcklk\nPjAzMDE0NTEzMjE8L2NvcjpmaWxlcklkPgogICAgPGNvcjpmaWxlckNjYz4jZWVjYjk4YTwvY29y\nOmZpbGVyQ2NjPgogICAgPGNvcjpmaWxlckZvcm1UeXBlPlMtMTwvY29yOmZpbGVyRm9ybVR5cGU+\nCiAgPC9jb3I6ZmlsZXI+CiAgPGNvcjpzcm9zPgogICAgPGNvbTpzcm9JZD5OT05FPC9jb206c3Jv\nSWQ+CiAgPC9jb3I6c3Jvcz4KICA8Y29yOnNtYWxsQnVzaW5lc3NGbGFnPmZhbHNlPC9jb3I6c21h\nbGxCdXNpbmVzc0ZsYWc+CiAgPGNvcjplbWVyZ2luZ0dyb3d0aENvbXBhbnlGbGFnPmZhbHNlPC9j\nb3I6ZW1lcmdpbmdHcm93dGhDb21wYW55RmxhZz4KICA8Y29yOm5vdGlmaWNhdGlvbnM+CiAgICA8\nY29tOmludGVybmV0Tm90aWZpY2F0aW9uQWRkcmVzcz5vaGhAc2VjLmdvdjwvY29tOmludGVybmV0\nTm90aWZpY2F0aW9uQWRkcmVzcz4KICA8L2Nvcjpub3RpZmljYXRpb25zPgogIDxjb3I6ZG9jdW1l\nbnRzPgogICAgPGNvbTpkb2N1bWVudD4KICAgICAgPGNvbTpjb25mb3JtZWROYW1lPmRvYzEudHh0\nPC9jb206Y29uZm9ybWVkTmFtZT4KICAgICAgPGNvbTpjb25mb3JtZWREb2N1bWVudFR5cGU+Uy0x\nPC9jb206Y29uZm9ybWVkRG9jdW1lbnRUeXBlPgogICAgICA8Y29tOmNvbnRlbnRzPktpb3FLaW9x\nS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FEUXBHYVhKemRDQmti\nMk4xYldWdQpkQTBLRFFvZ0lDQWdJQ0FnSUZOUVJVTkpUVVZPSUMwZ1RrOVVJRUZPSUU5R1JrbERT\nVUZNSUVaSlRFbE9SdzBLRFFvcUtpb3EKS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FL\naW9xS2lvcUtpb3FLaW9OQ2cwSwo8L2NvbTpjb250ZW50cz4KICAgIDwvY29tOmRvY3VtZW50Pgog\nICAgPGNvbTpkb2N1bWVudD4KICAgICAgPGNvbTpjb25mb3JtZWROYW1lPmRvYzIudHh0PC9jb206\nY29uZm9ybWVkTmFtZT4KICAgICAgPGNvbTpjb25mb3JtZWREb2N1bWVudFR5cGU+Q09WRVI8L2Nv\nbTpjb25mb3JtZWREb2N1bWVudFR5cGU+CiAgICAgIDxjb206Y29udGVudHM+S2lvcUtpb3FLaW9x\nS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcURRcEJaSFpoYm1ObFpDQlRi\nMlowCmQyRnlaU0JUZVhOMFpXMXpEUW9nSUNBZ0lDQWdJRk5RUlVOSlRVVk9JQzBnVGs5VUlFRk9J\nRTlHUmtsRFNVRk1JRVpKVEVsTwpSdzBLRFFvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FL\naW9xS2lvcUtpb3FLaW9xS2lvcUtpb05DZzBLCjwvY29tOmNvbnRlbnRzPgogICAgPC9jb206ZG9j\ndW1lbnQ+CiAgPC9jb3I6ZG9jdW1lbnRzPgogIDxjb3I6ZWRnYXJGZWU+CiAgICA8Y29yOnN1Ym1p\nc3Npb25GZWU+CiAgICAgIDxmZWVjOmZlZVBheW9ySW5mb3JtYXRpb24+CiAgICAgICAgPGZlZWM6\nZmlsZXJJZD4wMDAxMTI1ODUxPC9mZWVjOmZpbGVySWQ+CiAgICAgICAgPGZlZWM6ZmlsZXJDY2M+\nI3RlY2gxMjM8L2ZlZWM6ZmlsZXJDY2M+CiAgICAgIDwvZmVlYzpmZWVQYXlvckluZm9ybWF0aW9u\nPgogICAgICA8ZmVlYzpmZWVQYXltZW50TWV0aG9kPkZFRFdJUkU8L2ZlZWM6ZmVlUGF5bWVudE1l\ndGhvZD4KICAgICAgPGZlZWM6ZmVlQW1vdW50PjE0LjQwPC9mZWVjOmZlZUFtb3VudD4KICAgIDwv\nY29yOnN1Ym1pc3Npb25GZWU+CiAgICA8Y29yOnN1Ym1pc3Npb25PZmZlcmluZz4KICAgICAgPGZl\nZWM6ZmVlT2ZmZXJpbmdTZWN1cml0eU5hbWU+RGVidDwvZmVlYzpmZWVPZmZlcmluZ1NlY3VyaXR5\nTmFtZT4KICAgICAgPGZlZWM6ZmVlT2ZmZXJpbmdTaGFyZXM+MTEwMTwvZmVlYzpmZWVPZmZlcmlu\nZ1NoYXJlcz4KICAgICAgPGZlZWM6ZmVlT2ZmZXJpbmdBbW91bnRQZXJTaGFyZT4xMDAwLjAwMDA8\nL2ZlZWM6ZmVlT2ZmZXJpbmdBbW91bnRQZXJTaGFyZT4KICAgICAgPGZlZWM6ZmVlT2ZmZXJpbmdB\nZ2dyZWdhdGVQcmljZT4xMTAxMDIuMzY8L2ZlZWM6ZmVlT2ZmZXJpbmdBZ2dyZWdhdGVQcmljZT4K\nICAgIDwvY29yOnN1Ym1pc3Npb25PZmZlcmluZz4KICA8L2NvcjplZGdhckZlZT4KPC9jb3I6ZWRn\nYXJTdWJtaXNzaW9uPg==\n\n \n \n 8-K.xml\n PD94bWwgdmVyc2lvbj0iMS4wIiA/Pjxjb3I6ZWRnYXJTdWJtaXNzaW9uIHhtbG5zOmNvcj0iaHR0\ncDovL3d3dy5zZWMuZ292L2VkZ2FyL2NvcmVnIiB4bWxuczpjb209Imh0dHA6Ly93d3cuc2VjLmdv\ndi9lZGdhci9jb21tb24iPgogIDxjb3I6bGl2ZVRlc3RGbGFnPkxJVkU8L2NvcjpsaXZlVGVzdEZs\nYWc+CiAgPGNvcjpmbGFncz4KICAgIDxjb206Y29uZmlybWluZ0NvcHlGbGFnPmZhbHNlPC9jb206\nY29uZmlybWluZ0NvcHlGbGFnPgogICAgPGNvbTpvdmVycmlkZUludGVybmV0RmxhZz5mYWxzZTwv\nY29tOm92ZXJyaWRlSW50ZXJuZXRGbGFnPgogICAgPGNvbTpyZXR1cm5Db3B5RmxhZz5mYWxzZTwv\nY29tOnJldHVybkNvcHlGbGFnPgogIDwvY29yOmZsYWdzPgogIDxjb3I6c3VibWlzc2lvblR5cGU+\nOC1LPC9jb3I6c3VibWlzc2lvblR5cGU+CiAgPGNvcjpmaWxlcj4KICAgIDxjb3I6ZmlsZXJJZD4w\nMzAxNzIyODQ4PC9jb3I6ZmlsZXJJZD4KICAgIDxjb3I6ZmlsZXJDY2M+YmNjOW9lI2U8L2Nvcjpm\naWxlckNjYz4KICA8L2NvcjpmaWxlcj4KICA8Y29yOnNyb3M+CiAgICA8Y29tOnNyb0lkPk5PTkU8\nL2NvbTpzcm9JZD4KICA8L2Nvcjpzcm9zPgogIDxjb3I6aXRlbXM+CiAgICA8Y29yOml0ZW0+MS4w\nMTwvY29yOml0ZW0+CiAgPC9jb3I6aXRlbXM+CiAgPGNvcjplbWVyZ2luZ0dyb3d0aENvbXBhbnlG\nbGFnPnRydWU8L2NvcjplbWVyZ2luZ0dyb3d0aENvbXBhbnlGbGFnPgogIDxjb3I6ZG9jdW1lbnRz\nPgogICAgPGNvbTpkb2N1bWVudD4KICAgICAgPGNvbTpjb25mb3JtZWROYW1lPmZpbGUudHh0PC9j\nb206Y29uZm9ybWVkTmFtZT4KICAgICAgPGNvbTpjb25mb3JtZWREb2N1bWVudFR5cGU+OC1LPC9j\nb206Y29uZm9ybWVkRG9jdW1lbnRUeXBlPgogICAgICA8Y29tOmNvbnRlbnRzPmRHVnpkQT09PC9j\nb206Y29udGVudHM+CiAgICA8L2NvbTpkb2N1bWVudD4KICA8L2Nvcjpkb2N1bWVudHM+CjwvY29y\nOmVkZ2FyU3VibWlzc2lvbj4=\n\n \n \n" } }, "schema" : { "type" : "string", "format" : "xml" } }, "application/xml" : { "examples" : { "Bulk Live Submission" : { "description" : "A valid bulk live submission", "value" : "\n\n LIVE\n \n \n S-1.xml\n PD94bWwgdmVyc2lvbj0iMS4wIiA/Pjxjb3I6ZWRnYXJTdWJtaXNzaW9uIHhtbG5zOmNvcj0iaHR0\ncDovL3d3dy5zZWMuZ292L2VkZ2FyL2NvcmVnZmVlIiB4bWxuczpjb209Imh0dHA6Ly93d3cuc2Vj\nLmdvdi9lZGdhci9jb21tb24iIHhtbG5zOmZlZWM9Imh0dHA6Ly93d3cuc2VjLmdvdi9lZGdhci9m\nZWVjb21tb24iPgogIDxjb3I6bGl2ZVRlc3RGbGFnPkxJVkU8L2NvcjpsaXZlVGVzdEZsYWc+CiAg\nPGNvcjpmbGFncz4KICAgIDxjb3I6Y29uZmlybWluZ0NvcHlGbGFnPmZhbHNlPC9jb3I6Y29uZmly\nbWluZ0NvcHlGbGFnPgogICAgPGNvcjpkZWxheWluZ0FtZW5kbWVudEZsYWc+ZmFsc2U8L2Nvcjpk\nZWxheWluZ0FtZW5kbWVudEZsYWc+CiAgICA8Y29yOm92ZXJyaWRlSW50ZXJuZXRGbGFnPmZhbHNl\nPC9jb3I6b3ZlcnJpZGVJbnRlcm5ldEZsYWc+CiAgICA8Y29yOnJldHVybkNvcHlGbGFnPmZhbHNl\nPC9jb3I6cmV0dXJuQ29weUZsYWc+CiAgPC9jb3I6ZmxhZ3M+CiAgPGNvcjpzdWJtaXNzaW9uVHlw\nZT5TLTE8L2NvcjpzdWJtaXNzaW9uVHlwZT4KICA8Y29yOmZpbGVyPgogICAgPGNvcjpmaWxlcklk\nPjAzMDE0NTEzMjE8L2NvcjpmaWxlcklkPgogICAgPGNvcjpmaWxlckNjYz4jZWVjYjk4YTwvY29y\nOmZpbGVyQ2NjPgogICAgPGNvcjpmaWxlckZvcm1UeXBlPlMtMTwvY29yOmZpbGVyRm9ybVR5cGU+\nCiAgPC9jb3I6ZmlsZXI+CiAgPGNvcjpzcm9zPgogICAgPGNvbTpzcm9JZD5OT05FPC9jb206c3Jv\nSWQ+CiAgPC9jb3I6c3Jvcz4KICA8Y29yOnNtYWxsQnVzaW5lc3NGbGFnPmZhbHNlPC9jb3I6c21h\nbGxCdXNpbmVzc0ZsYWc+CiAgPGNvcjplbWVyZ2luZ0dyb3d0aENvbXBhbnlGbGFnPmZhbHNlPC9j\nb3I6ZW1lcmdpbmdHcm93dGhDb21wYW55RmxhZz4KICA8Y29yOm5vdGlmaWNhdGlvbnM+CiAgICA8\nY29tOmludGVybmV0Tm90aWZpY2F0aW9uQWRkcmVzcz5vaGhAc2VjLmdvdjwvY29tOmludGVybmV0\nTm90aWZpY2F0aW9uQWRkcmVzcz4KICA8L2Nvcjpub3RpZmljYXRpb25zPgogIDxjb3I6ZG9jdW1l\nbnRzPgogICAgPGNvbTpkb2N1bWVudD4KICAgICAgPGNvbTpjb25mb3JtZWROYW1lPmRvYzEudHh0\nPC9jb206Y29uZm9ybWVkTmFtZT4KICAgICAgPGNvbTpjb25mb3JtZWREb2N1bWVudFR5cGU+Uy0x\nPC9jb206Y29uZm9ybWVkRG9jdW1lbnRUeXBlPgogICAgICA8Y29tOmNvbnRlbnRzPktpb3FLaW9x\nS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FEUXBHYVhKemRDQmti\nMk4xYldWdQpkQTBLRFFvZ0lDQWdJQ0FnSUZOUVJVTkpUVVZPSUMwZ1RrOVVJRUZPSUU5R1JrbERT\nVUZNSUVaSlRFbE9SdzBLRFFvcUtpb3EKS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FL\naW9xS2lvcUtpb3FLaW9OQ2cwSwo8L2NvbTpjb250ZW50cz4KICAgIDwvY29tOmRvY3VtZW50Pgog\nICAgPGNvbTpkb2N1bWVudD4KICAgICAgPGNvbTpjb25mb3JtZWROYW1lPmRvYzIudHh0PC9jb206\nY29uZm9ybWVkTmFtZT4KICAgICAgPGNvbTpjb25mb3JtZWREb2N1bWVudFR5cGU+Q09WRVI8L2Nv\nbTpjb25mb3JtZWREb2N1bWVudFR5cGU+CiAgICAgIDxjb206Y29udGVudHM+S2lvcUtpb3FLaW9x\nS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcURRcEJaSFpoYm1ObFpDQlRi\nMlowCmQyRnlaU0JUZVhOMFpXMXpEUW9nSUNBZ0lDQWdJRk5RUlVOSlRVVk9JQzBnVGs5VUlFRk9J\nRTlHUmtsRFNVRk1JRVpKVEVsTwpSdzBLRFFvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FL\naW9xS2lvcUtpb3FLaW9xS2lvcUtpb05DZzBLCjwvY29tOmNvbnRlbnRzPgogICAgPC9jb206ZG9j\ndW1lbnQ+CiAgPC9jb3I6ZG9jdW1lbnRzPgogIDxjb3I6ZWRnYXJGZWU+CiAgICA8Y29yOnN1Ym1p\nc3Npb25GZWU+CiAgICAgIDxmZWVjOmZlZVBheW9ySW5mb3JtYXRpb24+CiAgICAgICAgPGZlZWM6\nZmlsZXJJZD4wMDAxMTI1ODUxPC9mZWVjOmZpbGVySWQ+CiAgICAgICAgPGZlZWM6ZmlsZXJDY2M+\nI3RlY2gxMjM8L2ZlZWM6ZmlsZXJDY2M+CiAgICAgIDwvZmVlYzpmZWVQYXlvckluZm9ybWF0aW9u\nPgogICAgICA8ZmVlYzpmZWVQYXltZW50TWV0aG9kPkZFRFdJUkU8L2ZlZWM6ZmVlUGF5bWVudE1l\ndGhvZD4KICAgICAgPGZlZWM6ZmVlQW1vdW50PjE0LjQwPC9mZWVjOmZlZUFtb3VudD4KICAgIDwv\nY29yOnN1Ym1pc3Npb25GZWU+CiAgICA8Y29yOnN1Ym1pc3Npb25PZmZlcmluZz4KICAgICAgPGZl\nZWM6ZmVlT2ZmZXJpbmdTZWN1cml0eU5hbWU+RGVidDwvZmVlYzpmZWVPZmZlcmluZ1NlY3VyaXR5\nTmFtZT4KICAgICAgPGZlZWM6ZmVlT2ZmZXJpbmdTaGFyZXM+MTEwMTwvZmVlYzpmZWVPZmZlcmlu\nZ1NoYXJlcz4KICAgICAgPGZlZWM6ZmVlT2ZmZXJpbmdBbW91bnRQZXJTaGFyZT4xMDAwLjAwMDA8\nL2ZlZWM6ZmVlT2ZmZXJpbmdBbW91bnRQZXJTaGFyZT4KICAgICAgPGZlZWM6ZmVlT2ZmZXJpbmdB\nZ2dyZWdhdGVQcmljZT4xMTAxMDIuMzY8L2ZlZWM6ZmVlT2ZmZXJpbmdBZ2dyZWdhdGVQcmljZT4K\nICAgIDwvY29yOnN1Ym1pc3Npb25PZmZlcmluZz4KICA8L2NvcjplZGdhckZlZT4KPC9jb3I6ZWRn\nYXJTdWJtaXNzaW9uPg==\n\n \n \n 8-K.xml\n PD94bWwgdmVyc2lvbj0iMS4wIiA/Pjxjb3I6ZWRnYXJTdWJtaXNzaW9uIHhtbG5zOmNvcj0iaHR0\ncDovL3d3dy5zZWMuZ292L2VkZ2FyL2NvcmVnIiB4bWxuczpjb209Imh0dHA6Ly93d3cuc2VjLmdv\ndi9lZGdhci9jb21tb24iPgogIDxjb3I6bGl2ZVRlc3RGbGFnPkxJVkU8L2NvcjpsaXZlVGVzdEZs\nYWc+CiAgPGNvcjpmbGFncz4KICAgIDxjb206Y29uZmlybWluZ0NvcHlGbGFnPmZhbHNlPC9jb206\nY29uZmlybWluZ0NvcHlGbGFnPgogICAgPGNvbTpvdmVycmlkZUludGVybmV0RmxhZz5mYWxzZTwv\nY29tOm92ZXJyaWRlSW50ZXJuZXRGbGFnPgogICAgPGNvbTpyZXR1cm5Db3B5RmxhZz5mYWxzZTwv\nY29tOnJldHVybkNvcHlGbGFnPgogIDwvY29yOmZsYWdzPgogIDxjb3I6c3VibWlzc2lvblR5cGU+\nOC1LPC9jb3I6c3VibWlzc2lvblR5cGU+CiAgPGNvcjpmaWxlcj4KICAgIDxjb3I6ZmlsZXJJZD4w\nMzAxNzIyODQ4PC9jb3I6ZmlsZXJJZD4KICAgIDxjb3I6ZmlsZXJDY2M+YmNjOW9lI2U8L2Nvcjpm\naWxlckNjYz4KICA8L2NvcjpmaWxlcj4KICA8Y29yOnNyb3M+CiAgICA8Y29tOnNyb0lkPk5PTkU8\nL2NvbTpzcm9JZD4KICA8L2Nvcjpzcm9zPgogIDxjb3I6aXRlbXM+CiAgICA8Y29yOml0ZW0+MS4w\nMTwvY29yOml0ZW0+CiAgPC9jb3I6aXRlbXM+CiAgPGNvcjplbWVyZ2luZ0dyb3d0aENvbXBhbnlG\nbGFnPnRydWU8L2NvcjplbWVyZ2luZ0dyb3d0aENvbXBhbnlGbGFnPgogIDxjb3I6ZG9jdW1lbnRz\nPgogICAgPGNvbTpkb2N1bWVudD4KICAgICAgPGNvbTpjb25mb3JtZWROYW1lPmZpbGUudHh0PC9j\nb206Y29uZm9ybWVkTmFtZT4KICAgICAgPGNvbTpjb25mb3JtZWREb2N1bWVudFR5cGU+OC1LPC9j\nb206Y29uZm9ybWVkRG9jdW1lbnRUeXBlPgogICAgICA8Y29tOmNvbnRlbnRzPmRHVnpkQT09PC9j\nb206Y29udGVudHM+CiAgICA8L2NvbTpkb2N1bWVudD4KICA8L2Nvcjpkb2N1bWVudHM+CjwvY29y\nOmVkZ2FyU3VibWlzc2lvbj4=\n\n \n \n" } }, "schema" : { "type" : "string", "format" : "xml" } } }, "required" : true }, "responses" : { "202" : { "description" : "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.", "content" : { "application/json" : { "examples" : { "Accepted" : { "summary" : "Accepted. The BULK TEST filing has been transmitted to EDGAR and accession number(s) generated", "description" : "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.", "value" : { "tracking" : "8bdd9ff5f82da173d41bf1ed03a80af4", "locator" : "47a94d", "status" : "RECEIVED", "responses" : [ { "accessionNumber" : "0000000000-22-000001", "type" : "LIVE", "messages" : [ ] }, { "accessionNumber" : "0000000000-22-000006", "type" : "LIVE", "messages" : [ ] } ] } } }, "schema" : { "$ref" : "#/components/schemas/ListSubmissionResponse" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "examples" : { "Blank/Empty CIK for X-EDGAR-LOGIN-CIK" : { "description" : "If the header X-EDGAR-LOGIN-CIK (or X-EDGAR-CIK) is provided it must not be blank or empty.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "If the header X-EDGAR-LOGIN-CIK (or X-EDGAR-CIK) is provided it must not be blank or empty." } ] } }, "Invalid CIK for X-EDGAR-LOGIN-CIK" : { "description" : "If the header X-EDGAR-LOGIN-CIK (or X-EDGAR-CIK) is provided it must be a valid CIK.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "If the header X-EDGAR-LOGIN-CIK (or X-EDGAR-CIK) is provided it must be a valid CIK." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.", "content" : { "application/json" : { "examples" : { "Unauthorized" : { "description" : "The request does not include any valid tokens for accessing this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Unauthorized" } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "403" : { "description" : "Forbidden. A valid Filer API Token and User Access Token must be provided with this request. Please ensure that the User identified by the User Access Token is authorized to file (1) for the CIK associated with the Filer API Token and (2) for any CIKs for which filings are being submitted.", "content" : { "application/json" : { "examples" : { "Forbidden" : { "description" : "The Filer API Token and User API Token are present and valid but do not provide required permissions to use this resource. Check delegation and permissions in Filer Management.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Forbidden." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "500" : { "description" : "Server error. An unexpected server-side error has occurred.", "content" : { "application/json" : { "examples" : { "Server Error" : { "description" : "An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "An unexpected error has occurred." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "A request was made to this resource outside of operational hours.", "content" : { "application/json" : { "examples" : { "Out of Operational Hours" : { "description" : "A request was made to this resource outside of the windows of operation for the EDGAR system and this request could not be completed. This status is also returned when the operational status of EDGAR cannot be determined.", "value" : { "tracking" : "44230c24bc6ce1b884cc5b739819d29942", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "EDGAR is not available because EDGAR is reporting that it is not within operating hours." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "security" : [ { "Filer API Token and User API Token" : [ ] } ], "servers" : [ { "url" : "https://api.edgarfiling.sec.gov", "description" : "EDGAR Submission API" } ] } }, "/submission/bulk/test" : { "post" : { "summary" : "Bulk Test Submission", "description" : "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.", "operationId" : "Bulk Test Submission", "tags" : [ "Submission API" ], "parameters" : [ { "deprecated" : true, "description" : "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.", "examples" : { "None" : { }, "Example CIK" : { "value" : "0000350001" } }, "in" : "header", "name" : "X-EDGAR-CIK", "schema" : { "type" : "string" } }, { "description" : "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.", "examples" : { "None" : { }, "Example CIK" : { "value" : "0000350001" } }, "in" : "header", "name" : "X-EDGAR-LOGIN-CIK", "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "A bulk test filing, in XML format, that will be transmitted to EDGAR and processed.", "content" : { "application/octet-stream" : { "examples" : { "Bulk Test Submission" : { "description" : "A valid bulk test filing", "value" : "\n\n TEST\n \n \n S-1.xml\n PD94bWwgdmVyc2lvbj0iMS4wIiA/Pjxjb3I6ZWRnYXJTdWJtaXNzaW9uIHhtbG5zOmNvcj0iaHR0\ncDovL3d3dy5zZWMuZ292L2VkZ2FyL2NvcmVnZmVlIiB4bWxuczpjb209Imh0dHA6Ly93d3cuc2Vj\nLmdvdi9lZGdhci9jb21tb24iIHhtbG5zOmZlZWM9Imh0dHA6Ly93d3cuc2VjLmdvdi9lZGdhci9m\nZWVjb21tb24iPgogIDxjb3I6bGl2ZVRlc3RGbGFnPlRFU1Q8L2NvcjpsaXZlVGVzdEZsYWc+CiAg\nPGNvcjpmbGFncz4KICAgIDxjb3I6Y29uZmlybWluZ0NvcHlGbGFnPmZhbHNlPC9jb3I6Y29uZmly\nbWluZ0NvcHlGbGFnPgogICAgPGNvcjpkZWxheWluZ0FtZW5kbWVudEZsYWc+ZmFsc2U8L2Nvcjpk\nZWxheWluZ0FtZW5kbWVudEZsYWc+CiAgICA8Y29yOm92ZXJyaWRlSW50ZXJuZXRGbGFnPmZhbHNl\nPC9jb3I6b3ZlcnJpZGVJbnRlcm5ldEZsYWc+CiAgICA8Y29yOnJldHVybkNvcHlGbGFnPmZhbHNl\nPC9jb3I6cmV0dXJuQ29weUZsYWc+CiAgPC9jb3I6ZmxhZ3M+CiAgPGNvcjpzdWJtaXNzaW9uVHlw\nZT5TLTE8L2NvcjpzdWJtaXNzaW9uVHlwZT4KICA8Y29yOmZpbGVyPgogICAgPGNvcjpmaWxlcklk\nPjAzMDE0NTEzMjE8L2NvcjpmaWxlcklkPgogICAgPGNvcjpmaWxlckNjYz4jZWVjYjk4YTwvY29y\nOmZpbGVyQ2NjPgogICAgPGNvcjpmaWxlckZvcm1UeXBlPlMtMTwvY29yOmZpbGVyRm9ybVR5cGU+\nCiAgPC9jb3I6ZmlsZXI+CiAgPGNvcjpzcm9zPgogICAgPGNvbTpzcm9JZD5OT05FPC9jb206c3Jv\nSWQ+CiAgPC9jb3I6c3Jvcz4KICA8Y29yOnNtYWxsQnVzaW5lc3NGbGFnPmZhbHNlPC9jb3I6c21h\nbGxCdXNpbmVzc0ZsYWc+CiAgPGNvcjplbWVyZ2luZ0dyb3d0aENvbXBhbnlGbGFnPmZhbHNlPC9j\nb3I6ZW1lcmdpbmdHcm93dGhDb21wYW55RmxhZz4KICA8Y29yOm5vdGlmaWNhdGlvbnM+CiAgICA8\nY29tOmludGVybmV0Tm90aWZpY2F0aW9uQWRkcmVzcz5vaGhAc2VjLmdvdjwvY29tOmludGVybmV0\nTm90aWZpY2F0aW9uQWRkcmVzcz4KICA8L2Nvcjpub3RpZmljYXRpb25zPgogIDxjb3I6ZG9jdW1l\nbnRzPgogICAgPGNvbTpkb2N1bWVudD4KICAgICAgPGNvbTpjb25mb3JtZWROYW1lPmRvYzEudHh0\nPC9jb206Y29uZm9ybWVkTmFtZT4KICAgICAgPGNvbTpjb25mb3JtZWREb2N1bWVudFR5cGU+Uy0x\nPC9jb206Y29uZm9ybWVkRG9jdW1lbnRUeXBlPgogICAgICA8Y29tOmNvbnRlbnRzPktpb3FLaW9x\nS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FEUXBHYVhKemRDQmti\nMk4xYldWdQpkQTBLRFFvZ0lDQWdJQ0FnSUZOUVJVTkpUVVZPSUMwZ1RrOVVJRUZPSUU5R1JrbERT\nVUZNSUVaSlRFbE9SdzBLRFFvcUtpb3EKS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FL\naW9xS2lvcUtpb3FLaW9OQ2cwSwo8L2NvbTpjb250ZW50cz4KICAgIDwvY29tOmRvY3VtZW50Pgog\nICAgPGNvbTpkb2N1bWVudD4KICAgICAgPGNvbTpjb25mb3JtZWROYW1lPmRvYzIudHh0PC9jb206\nY29uZm9ybWVkTmFtZT4KICAgICAgPGNvbTpjb25mb3JtZWREb2N1bWVudFR5cGU+Q09WRVI8L2Nv\nbTpjb25mb3JtZWREb2N1bWVudFR5cGU+CiAgICAgIDxjb206Y29udGVudHM+S2lvcUtpb3FLaW9x\nS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcURRcEJaSFpoYm1ObFpDQlRi\nMlowCmQyRnlaU0JUZVhOMFpXMXpEUW9nSUNBZ0lDQWdJRk5RUlVOSlRVVk9JQzBnVGs5VUlFRk9J\nRTlHUmtsRFNVRk1JRVpKVEVsTwpSdzBLRFFvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FL\naW9xS2lvcUtpb3FLaW9xS2lvcUtpb05DZzBLCjwvY29tOmNvbnRlbnRzPgogICAgPC9jb206ZG9j\ndW1lbnQ+CiAgPC9jb3I6ZG9jdW1lbnRzPgogIDxjb3I6ZWRnYXJGZWU+CiAgICA8Y29yOnN1Ym1p\nc3Npb25GZWU+CiAgICAgIDxmZWVjOmZlZVBheW9ySW5mb3JtYXRpb24+CiAgICAgICAgPGZlZWM6\nZmlsZXJJZD4wMDAxMTI1ODUxPC9mZWVjOmZpbGVySWQ+CiAgICAgICAgPGZlZWM6ZmlsZXJDY2M+\nI3RlY2gxMjM8L2ZlZWM6ZmlsZXJDY2M+CiAgICAgIDwvZmVlYzpmZWVQYXlvckluZm9ybWF0aW9u\nPgogICAgICA8ZmVlYzpmZWVQYXltZW50TWV0aG9kPkZFRFdJUkU8L2ZlZWM6ZmVlUGF5bWVudE1l\ndGhvZD4KICAgICAgPGZlZWM6ZmVlQW1vdW50PjE0LjQwPC9mZWVjOmZlZUFtb3VudD4KICAgIDwv\nY29yOnN1Ym1pc3Npb25GZWU+CiAgICA8Y29yOnN1Ym1pc3Npb25PZmZlcmluZz4KICAgICAgPGZl\nZWM6ZmVlT2ZmZXJpbmdTZWN1cml0eU5hbWU+RGVidDwvZmVlYzpmZWVPZmZlcmluZ1NlY3VyaXR5\nTmFtZT4KICAgICAgPGZlZWM6ZmVlT2ZmZXJpbmdTaGFyZXM+MTEwMTwvZmVlYzpmZWVPZmZlcmlu\nZ1NoYXJlcz4KICAgICAgPGZlZWM6ZmVlT2ZmZXJpbmdBbW91bnRQZXJTaGFyZT4xMDAwLjAwMDA8\nL2ZlZWM6ZmVlT2ZmZXJpbmdBbW91bnRQZXJTaGFyZT4KICAgICAgPGZlZWM6ZmVlT2ZmZXJpbmdB\nZ2dyZWdhdGVQcmljZT4xMTAxMDIuMzY8L2ZlZWM6ZmVlT2ZmZXJpbmdBZ2dyZWdhdGVQcmljZT4K\nICAgIDwvY29yOnN1Ym1pc3Npb25PZmZlcmluZz4KICA8L2NvcjplZGdhckZlZT4KPC9jb3I6ZWRn\nYXJTdWJtaXNzaW9uPg==\n\n \n \n 8-K.xml\n PD94bWwgdmVyc2lvbj0iMS4wIiA/Pjxjb3I6ZWRnYXJTdWJtaXNzaW9uIHhtbG5zOmNvcj0iaHR0\ncDovL3d3dy5zZWMuZ292L2VkZ2FyL2NvcmVnIiB4bWxuczpjb209Imh0dHA6Ly93d3cuc2VjLmdv\ndi9lZGdhci9jb21tb24iPgogIDxjb3I6bGl2ZVRlc3RGbGFnPlRFU1Q8L2NvcjpsaXZlVGVzdEZs\nYWc+CiAgPGNvcjpmbGFncz4KICAgIDxjb206Y29uZmlybWluZ0NvcHlGbGFnPmZhbHNlPC9jb206\nY29uZmlybWluZ0NvcHlGbGFnPgogICAgPGNvbTpvdmVycmlkZUludGVybmV0RmxhZz5mYWxzZTwv\nY29tOm92ZXJyaWRlSW50ZXJuZXRGbGFnPgogICAgPGNvbTpyZXR1cm5Db3B5RmxhZz5mYWxzZTwv\nY29tOnJldHVybkNvcHlGbGFnPgogIDwvY29yOmZsYWdzPgogIDxjb3I6c3VibWlzc2lvblR5cGU+\nOC1LPC9jb3I6c3VibWlzc2lvblR5cGU+CiAgPGNvcjpmaWxlcj4KICAgIDxjb3I6ZmlsZXJJZD4w\nMzAxNzIyODQ4PC9jb3I6ZmlsZXJJZD4KICAgIDxjb3I6ZmlsZXJDY2M+YmNjOW9lI2U8L2Nvcjpm\naWxlckNjYz4KICA8L2NvcjpmaWxlcj4KICA8Y29yOnNyb3M+CiAgICA8Y29tOnNyb0lkPk5PTkU8\nL2NvbTpzcm9JZD4KICA8L2Nvcjpzcm9zPgogIDxjb3I6aXRlbXM+CiAgICA8Y29yOml0ZW0+MS4w\nMTwvY29yOml0ZW0+CiAgPC9jb3I6aXRlbXM+CiAgPGNvcjplbWVyZ2luZ0dyb3d0aENvbXBhbnlG\nbGFnPnRydWU8L2NvcjplbWVyZ2luZ0dyb3d0aENvbXBhbnlGbGFnPgogIDxjb3I6ZG9jdW1lbnRz\nPgogICAgPGNvbTpkb2N1bWVudD4KICAgICAgPGNvbTpjb25mb3JtZWROYW1lPmZpbGUudHh0PC9j\nb206Y29uZm9ybWVkTmFtZT4KICAgICAgPGNvbTpjb25mb3JtZWREb2N1bWVudFR5cGU+OC1LPC9j\nb206Y29uZm9ybWVkRG9jdW1lbnRUeXBlPgogICAgICA8Y29tOmNvbnRlbnRzPmRHVnpkQT09PC9j\nb206Y29udGVudHM+CiAgICA8L2NvbTpkb2N1bWVudD4KICA8L2Nvcjpkb2N1bWVudHM+CjwvY29y\nOmVkZ2FyU3VibWlzc2lvbj4=\n\n \n \n" } }, "schema" : { "type" : "string", "format" : "xml" } }, "application/xml" : { "examples" : { "Bulk Live Submission" : { "description" : "A valid bulk live submission", "value" : "\n\n TEST\n \n \n S-1.xml\n PD94bWwgdmVyc2lvbj0iMS4wIiA/Pjxjb3I6ZWRnYXJTdWJtaXNzaW9uIHhtbG5zOmNvcj0iaHR0\ncDovL3d3dy5zZWMuZ292L2VkZ2FyL2NvcmVnZmVlIiB4bWxuczpjb209Imh0dHA6Ly93d3cuc2Vj\nLmdvdi9lZGdhci9jb21tb24iIHhtbG5zOmZlZWM9Imh0dHA6Ly93d3cuc2VjLmdvdi9lZGdhci9m\nZWVjb21tb24iPgogIDxjb3I6bGl2ZVRlc3RGbGFnPlRFU1Q8L2NvcjpsaXZlVGVzdEZsYWc+CiAg\nPGNvcjpmbGFncz4KICAgIDxjb3I6Y29uZmlybWluZ0NvcHlGbGFnPmZhbHNlPC9jb3I6Y29uZmly\nbWluZ0NvcHlGbGFnPgogICAgPGNvcjpkZWxheWluZ0FtZW5kbWVudEZsYWc+ZmFsc2U8L2Nvcjpk\nZWxheWluZ0FtZW5kbWVudEZsYWc+CiAgICA8Y29yOm92ZXJyaWRlSW50ZXJuZXRGbGFnPmZhbHNl\nPC9jb3I6b3ZlcnJpZGVJbnRlcm5ldEZsYWc+CiAgICA8Y29yOnJldHVybkNvcHlGbGFnPmZhbHNl\nPC9jb3I6cmV0dXJuQ29weUZsYWc+CiAgPC9jb3I6ZmxhZ3M+CiAgPGNvcjpzdWJtaXNzaW9uVHlw\nZT5TLTE8L2NvcjpzdWJtaXNzaW9uVHlwZT4KICA8Y29yOmZpbGVyPgogICAgPGNvcjpmaWxlcklk\nPjAzMDE0NTEzMjE8L2NvcjpmaWxlcklkPgogICAgPGNvcjpmaWxlckNjYz4jZWVjYjk4YTwvY29y\nOmZpbGVyQ2NjPgogICAgPGNvcjpmaWxlckZvcm1UeXBlPlMtMTwvY29yOmZpbGVyRm9ybVR5cGU+\nCiAgPC9jb3I6ZmlsZXI+CiAgPGNvcjpzcm9zPgogICAgPGNvbTpzcm9JZD5OT05FPC9jb206c3Jv\nSWQ+CiAgPC9jb3I6c3Jvcz4KICA8Y29yOnNtYWxsQnVzaW5lc3NGbGFnPmZhbHNlPC9jb3I6c21h\nbGxCdXNpbmVzc0ZsYWc+CiAgPGNvcjplbWVyZ2luZ0dyb3d0aENvbXBhbnlGbGFnPmZhbHNlPC9j\nb3I6ZW1lcmdpbmdHcm93dGhDb21wYW55RmxhZz4KICA8Y29yOm5vdGlmaWNhdGlvbnM+CiAgICA8\nY29tOmludGVybmV0Tm90aWZpY2F0aW9uQWRkcmVzcz5vaGhAc2VjLmdvdjwvY29tOmludGVybmV0\nTm90aWZpY2F0aW9uQWRkcmVzcz4KICA8L2Nvcjpub3RpZmljYXRpb25zPgogIDxjb3I6ZG9jdW1l\nbnRzPgogICAgPGNvbTpkb2N1bWVudD4KICAgICAgPGNvbTpjb25mb3JtZWROYW1lPmRvYzEudHh0\nPC9jb206Y29uZm9ybWVkTmFtZT4KICAgICAgPGNvbTpjb25mb3JtZWREb2N1bWVudFR5cGU+Uy0x\nPC9jb206Y29uZm9ybWVkRG9jdW1lbnRUeXBlPgogICAgICA8Y29tOmNvbnRlbnRzPktpb3FLaW9x\nS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FEUXBHYVhKemRDQmti\nMk4xYldWdQpkQTBLRFFvZ0lDQWdJQ0FnSUZOUVJVTkpUVVZPSUMwZ1RrOVVJRUZPSUU5R1JrbERT\nVUZNSUVaSlRFbE9SdzBLRFFvcUtpb3EKS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FL\naW9xS2lvcUtpb3FLaW9OQ2cwSwo8L2NvbTpjb250ZW50cz4KICAgIDwvY29tOmRvY3VtZW50Pgog\nICAgPGNvbTpkb2N1bWVudD4KICAgICAgPGNvbTpjb25mb3JtZWROYW1lPmRvYzIudHh0PC9jb206\nY29uZm9ybWVkTmFtZT4KICAgICAgPGNvbTpjb25mb3JtZWREb2N1bWVudFR5cGU+Q09WRVI8L2Nv\nbTpjb25mb3JtZWREb2N1bWVudFR5cGU+CiAgICAgIDxjb206Y29udGVudHM+S2lvcUtpb3FLaW9x\nS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcURRcEJaSFpoYm1ObFpDQlRi\nMlowCmQyRnlaU0JUZVhOMFpXMXpEUW9nSUNBZ0lDQWdJRk5RUlVOSlRVVk9JQzBnVGs5VUlFRk9J\nRTlHUmtsRFNVRk1JRVpKVEVsTwpSdzBLRFFvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FL\naW9xS2lvcUtpb3FLaW9xS2lvcUtpb05DZzBLCjwvY29tOmNvbnRlbnRzPgogICAgPC9jb206ZG9j\ndW1lbnQ+CiAgPC9jb3I6ZG9jdW1lbnRzPgogIDxjb3I6ZWRnYXJGZWU+CiAgICA8Y29yOnN1Ym1p\nc3Npb25GZWU+CiAgICAgIDxmZWVjOmZlZVBheW9ySW5mb3JtYXRpb24+CiAgICAgICAgPGZlZWM6\nZmlsZXJJZD4wMDAxMTI1ODUxPC9mZWVjOmZpbGVySWQ+CiAgICAgICAgPGZlZWM6ZmlsZXJDY2M+\nI3RlY2gxMjM8L2ZlZWM6ZmlsZXJDY2M+CiAgICAgIDwvZmVlYzpmZWVQYXlvckluZm9ybWF0aW9u\nPgogICAgICA8ZmVlYzpmZWVQYXltZW50TWV0aG9kPkZFRFdJUkU8L2ZlZWM6ZmVlUGF5bWVudE1l\ndGhvZD4KICAgICAgPGZlZWM6ZmVlQW1vdW50PjE0LjQwPC9mZWVjOmZlZUFtb3VudD4KICAgIDwv\nY29yOnN1Ym1pc3Npb25GZWU+CiAgICA8Y29yOnN1Ym1pc3Npb25PZmZlcmluZz4KICAgICAgPGZl\nZWM6ZmVlT2ZmZXJpbmdTZWN1cml0eU5hbWU+RGVidDwvZmVlYzpmZWVPZmZlcmluZ1NlY3VyaXR5\nTmFtZT4KICAgICAgPGZlZWM6ZmVlT2ZmZXJpbmdTaGFyZXM+MTEwMTwvZmVlYzpmZWVPZmZlcmlu\nZ1NoYXJlcz4KICAgICAgPGZlZWM6ZmVlT2ZmZXJpbmdBbW91bnRQZXJTaGFyZT4xMDAwLjAwMDA8\nL2ZlZWM6ZmVlT2ZmZXJpbmdBbW91bnRQZXJTaGFyZT4KICAgICAgPGZlZWM6ZmVlT2ZmZXJpbmdB\nZ2dyZWdhdGVQcmljZT4xMTAxMDIuMzY8L2ZlZWM6ZmVlT2ZmZXJpbmdBZ2dyZWdhdGVQcmljZT4K\nICAgIDwvY29yOnN1Ym1pc3Npb25PZmZlcmluZz4KICA8L2NvcjplZGdhckZlZT4KPC9jb3I6ZWRn\nYXJTdWJtaXNzaW9uPg==\n\n \n \n 8-K.xml\n PD94bWwgdmVyc2lvbj0iMS4wIiA/Pjxjb3I6ZWRnYXJTdWJtaXNzaW9uIHhtbG5zOmNvcj0iaHR0\ncDovL3d3dy5zZWMuZ292L2VkZ2FyL2NvcmVnIiB4bWxuczpjb209Imh0dHA6Ly93d3cuc2VjLmdv\ndi9lZGdhci9jb21tb24iPgogIDxjb3I6bGl2ZVRlc3RGbGFnPlRFU1Q8L2NvcjpsaXZlVGVzdEZs\nYWc+CiAgPGNvcjpmbGFncz4KICAgIDxjb206Y29uZmlybWluZ0NvcHlGbGFnPmZhbHNlPC9jb206\nY29uZmlybWluZ0NvcHlGbGFnPgogICAgPGNvbTpvdmVycmlkZUludGVybmV0RmxhZz5mYWxzZTwv\nY29tOm92ZXJyaWRlSW50ZXJuZXRGbGFnPgogICAgPGNvbTpyZXR1cm5Db3B5RmxhZz5mYWxzZTwv\nY29tOnJldHVybkNvcHlGbGFnPgogIDwvY29yOmZsYWdzPgogIDxjb3I6c3VibWlzc2lvblR5cGU+\nOC1LPC9jb3I6c3VibWlzc2lvblR5cGU+CiAgPGNvcjpmaWxlcj4KICAgIDxjb3I6ZmlsZXJJZD4w\nMzAxNzIyODQ4PC9jb3I6ZmlsZXJJZD4KICAgIDxjb3I6ZmlsZXJDY2M+YmNjOW9lI2U8L2Nvcjpm\naWxlckNjYz4KICA8L2NvcjpmaWxlcj4KICA8Y29yOnNyb3M+CiAgICA8Y29tOnNyb0lkPk5PTkU8\nL2NvbTpzcm9JZD4KICA8L2Nvcjpzcm9zPgogIDxjb3I6aXRlbXM+CiAgICA8Y29yOml0ZW0+MS4w\nMTwvY29yOml0ZW0+CiAgPC9jb3I6aXRlbXM+CiAgPGNvcjplbWVyZ2luZ0dyb3d0aENvbXBhbnlG\nbGFnPnRydWU8L2NvcjplbWVyZ2luZ0dyb3d0aENvbXBhbnlGbGFnPgogIDxjb3I6ZG9jdW1lbnRz\nPgogICAgPGNvbTpkb2N1bWVudD4KICAgICAgPGNvbTpjb25mb3JtZWROYW1lPmZpbGUudHh0PC9j\nb206Y29uZm9ybWVkTmFtZT4KICAgICAgPGNvbTpjb25mb3JtZWREb2N1bWVudFR5cGU+OC1LPC9j\nb206Y29uZm9ybWVkRG9jdW1lbnRUeXBlPgogICAgICA8Y29tOmNvbnRlbnRzPmRHVnpkQT09PC9j\nb206Y29udGVudHM+CiAgICA8L2NvbTpkb2N1bWVudD4KICA8L2Nvcjpkb2N1bWVudHM+CjwvY29y\nOmVkZ2FyU3VibWlzc2lvbj4=\n\n \n \n" } }, "schema" : { "type" : "string", "format" : "xml" } } }, "required" : true }, "responses" : { "202" : { "description" : "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.", "content" : { "application/json" : { "examples" : { "Accepted" : { "summary" : "Accepted. The BULK TEST filing has been transmitted to EDGAR and accession number(s) generated", "description" : "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.", "value" : { "tracking" : "8bdd9ff5f82da173d41bf1ed03a80af4", "locator" : "47a94d", "responses" : [ { "accessionNumber" : "0000000000-22-000001", "type" : "TEST", "messages" : [ ] }, { "accessionNumber" : "0000000000-22-000009", "type" : "TEST", "messages" : [ ] } ] } } }, "schema" : { "$ref" : "#/components/schemas/ListSubmissionResponse" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "examples" : { "Blank/Empty CIK for X-EDGAR-LOGIN-CIK" : { "description" : "If the header X-EDGAR-LOGIN-CIK (or X-EDGAR-CIK) is provided it must not be blank or empty.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "If the header X-EDGAR-LOGIN-CIK (or X-EDGAR-CIK) is provided it must not be blank or empty." } ] } }, "Invalid CIK for X-EDGAR-LOGIN-CIK" : { "description" : "If the header X-EDGAR-LOGIN-CIK (or X-EDGAR-CIK) is provided it must be a valid CIK.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "If the header X-EDGAR-LOGIN-CIK (or X-EDGAR-CIK) is provided it must be a valid CIK." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.", "content" : { "application/json" : { "examples" : { "Unauthorized" : { "description" : "The request does not include any valid tokens for accessing this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Unauthorized" } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "403" : { "description" : "Forbidden. A valid Filer API Token and User Access Token must be provided with this request. Please ensure that the User identified by the User Access Token is authorized to file (1) for the CIK associated with the Filer API Token and (2) for any CIKs for which filings are being submitted.", "content" : { "application/json" : { "examples" : { "Forbidden" : { "description" : "Forbidden", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Forbidden." } ] } }, "Forbidden with Reason" : { "description" : "The Filer API Token and User API Token are present and valid but do not provide required permissions to use this resource. Check delegation and permissions in Filer Management.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "The user 'john.doe@filer.biz' cannot file for the login CIK 0000350001, check permissions in Filer Management." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "500" : { "description" : "Server error. An unexpected server-side error has occurred.", "content" : { "application/json" : { "examples" : { "Server Error" : { "description" : "An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "An unexpected error has occurred." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "A request was made to this resource outside of operational hours.", "content" : { "application/json" : { "examples" : { "Out of Operational Hours" : { "description" : "A request was made to this resource outside of the windows of operation for the EDGAR system and this request could not be completed. This status is also returned when the operational status of EDGAR cannot be determined.", "value" : { "tracking" : "44230c24bc6ce1b884cc5b739819d29942", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "EDGAR is not available because EDGAR is reporting that it is not within operating hours." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "security" : [ { "Filer API Token and User API Token" : [ ] } ], "servers" : [ { "url" : "https://api.edgarfiling.sec.gov", "description" : "EDGAR Submission API" } ] } }, "/submission/single/live" : { "post" : { "summary" : "Single Live Submission", "description" : "Allows an authorized filer to transmit a SINGLE LIVE submission file. When an authorized filer transmits a filing to this resource it will transmit the file to EDGAR and return an accession number. EDGAR will then begin processing the submission.", "operationId" : "Single Live Submission", "tags" : [ "Submission API" ], "parameters" : [ { "deprecated" : true, "description" : "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.", "examples" : { "None" : { }, "Example CIK" : { "value" : "0000350001" } }, "in" : "header", "name" : "X-EDGAR-CIK", "schema" : { "type" : "string" } }, { "description" : "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.", "examples" : { "None" : { }, "Example CIK" : { "value" : "0000350001" } }, "in" : "header", "name" : "X-EDGAR-LOGIN-CIK", "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "A single live submission, in XML format, that will be transmitted to EDGAR and processed.", "content" : { "application/octet-stream" : { "examples" : { "Single Live Submission (8-K)" : { "description" : "A valid single live 8-K submission", "value" : "\n\n LIVE\n \n false\n false\n false\n \n 8-K\n \n 1821451321\n #decb44a\n \n \n NONE\n \n \n 1.01\n \n true\n \n \n file.txt\n 8-K\n dGVzdA==\n \n \n" }, "Single Live Submission (S-1)" : { "description" : "A valid single live S-1 submission", "value" : "\n\n LIVE\n \n false\n false\n false\n false\n \n S-1\n \n 1821451321\n #decb44a\n S-1\n \n \n NONE\n \n false\n false\n \n tonotify@company.com\n \n \n \n doc1.txt\n S-1\n KioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqDQpGaXJzdCBkb2N1bWVu\ndA0KDQogICAgICAgIFNQRUNJTUVOIC0gTk9UIEFOIE9GRklDSUFMIEZJTElORw0KDQoqKioq\nKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioNCg0K\n\n \n \n doc2.txt\n COVER\n KioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqDQpBZHZhbmNlZCBTb2Z0\nd2FyZSBTeXN0ZW1zDQogICAgICAgIFNQRUNJTUVOIC0gTk9UIEFOIE9GRklDSUFMIEZJTElO\nRw0KDQoqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioNCg0K\n\n \n \n \n \n \n 1821451322\n #g9abz11\n \n FEDWIRE\n 14.40\n \n \n Debt\n 1101\n 1000.0000\n 110102.36\n \n \n" } }, "schema" : { "type" : "string", "format" : "xml" } }, "application/xml" : { "examples" : { "Single Live Submission (8-K)" : { "description" : "A valid single live 8-K submission", "value" : "\n\n LIVE\n \n false\n false\n false\n \n 8-K\n \n 1821451321\n #decb44a\n \n \n NONE\n \n \n 1.01\n \n true\n \n \n file.txt\n 8-K\n dGVzdA==\n \n \n" }, "Single Live Submission (S-1)" : { "description" : "A valid single live S-1 submission", "value" : "\n\n LIVE\n \n false\n false\n false\n false\n \n S-1\n \n 1821451321\n #decb44a\n S-1\n \n \n NONE\n \n false\n false\n \n tonotify@company.com\n \n \n \n doc1.txt\n S-1\n KioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqDQpGaXJzdCBkb2N1bWVu\ndA0KDQogICAgICAgIFNQRUNJTUVOIC0gTk9UIEFOIE9GRklDSUFMIEZJTElORw0KDQoqKioq\nKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioNCg0K\n\n \n \n doc2.txt\n COVER\n KioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqDQpBZHZhbmNlZCBTb2Z0\nd2FyZSBTeXN0ZW1zDQogICAgICAgIFNQRUNJTUVOIC0gTk9UIEFOIE9GRklDSUFMIEZJTElO\nRw0KDQoqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioNCg0K\n\n \n \n \n \n \n 1821451322\n #g9abz11\n \n FEDWIRE\n 14.40\n \n \n Debt\n 1101\n 1000.0000\n 110102.36\n \n \n" } }, "schema" : { "type" : "string", "format" : "xml" } } }, "required" : true }, "responses" : { "202" : { "description" : "Accepted. The filing has been transmitted to the SINGLE LIVE resource and the EDGAR system has generated an accession number. The submission has begun processing.", "content" : { "application/json" : { "examples" : { "Accepted" : { "summary" : "Accepted. The SINGLE LIVE filing has been transmitted to EDGAR and accession number(s) generated", "description" : "Accepted. The filing has been transmitted to the SINGLE LIVE resource and the EDGAR system has generated an accession number. The submission has begun processing.", "value" : { "tracking" : "820c24bc6ce9ce84cc5b739819d27742", "locator" : "47a94d", "accessionNumber" : "0000000000-22-000001", "type" : "LIVE", "messages" : [ ] } } }, "schema" : { "$ref" : "#/components/schemas/SingleSubmissionResponse" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "examples" : { "Blank/Empty CIK for X-EDGAR-LOGIN-CIK" : { "description" : "If the header X-EDGAR-LOGIN-CIK (or X-EDGAR-CIK) is provided it must not be blank or empty.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "If the header X-EDGAR-LOGIN-CIK (or X-EDGAR-CIK) is provided it must not be blank or empty." } ] } }, "Invalid CIK for X-EDGAR-LOGIN-CIK" : { "description" : "If the header X-EDGAR-LOGIN-CIK (or X-EDGAR-CIK) is provided it must be a valid CIK.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "If the header X-EDGAR-LOGIN-CIK (or X-EDGAR-CIK) is provided it must be a valid CIK." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.", "content" : { "application/json" : { "examples" : { "Unauthorized" : { "description" : "The request does not include any valid tokens for accessing this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Unauthorized" } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "403" : { "description" : "Forbidden. A valid Filer API Token and User Access Token must be provided with this request. Please ensure that the User identified by the User Access Token is authorized to file (1) for the CIK associated with the Filer API Token and (2) for any CIKs for which filings are being submitted.", "content" : { "application/json" : { "examples" : { "Forbidden" : { "description" : "The Filer API Token and User API Token are present and valid but do not provide required permissions to use this resource. Check delegation and permissions in Filer Management.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Forbidden." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "500" : { "description" : "Server error. An unexpected server-side error has occurred.", "content" : { "application/json" : { "examples" : { "Server Error" : { "description" : "An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "An unexpected error has occurred." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "A request was made to this resource outside of operational hours.", "content" : { "application/json" : { "examples" : { "Out of Operational Hours" : { "description" : "A request was made to this resource outside of the windows of operation for the EDGAR system and this request could not be completed. This status is also returned when the operational status of EDGAR cannot be determined.", "value" : { "tracking" : "44230c24bc6ce1b884cc5b739819d29942", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "EDGAR is not available because EDGAR is reporting that it is not within operating hours." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "security" : [ { "Filer API Token and User API Token" : [ ] } ], "servers" : [ { "url" : "https://api.edgarfiling.sec.gov", "description" : "EDGAR Submission API" } ] } }, "/submission/single/test" : { "post" : { "summary" : "Single Test Submission", "description" : "Allows an authorized filer to transmit a SINGLE TEST submission file. When an authorized filer transmits a filing to this resource it will transmit the file to EDGAR and return an accession number. EDGAR will then begin processing the submission.", "operationId" : "Single Test Submission", "tags" : [ "Submission API" ], "parameters" : [ { "deprecated" : true, "description" : "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.", "examples" : { "None" : { }, "Example CIK" : { "value" : "0000350001" } }, "in" : "header", "name" : "X-EDGAR-CIK", "schema" : { "type" : "string" } }, { "description" : "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.", "examples" : { "None" : { }, "Example CIK" : { "value" : "0000350001" } }, "in" : "header", "name" : "X-EDGAR-LOGIN-CIK", "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "A single test submission, in XML format, that will be transmitted to EDGAR and processed.", "content" : { "application/octet-stream" : { "examples" : { "Single Test Submission (8-K)" : { "description" : "A valid single test 8-K submission", "value" : "\n\n TEST\n \n false\n false\n false\n \n 8-K\n \n 1821451321\n #decb44a\n \n \n NONE\n \n \n 1.01\n \n true\n \n \n file.txt\n 8-K\n dGVzdA==\n \n \n" }, "Single Test Submission (S-1)" : { "description" : "A valid single test S-1 submission", "value" : "\n\n TEST\n \n false\n false\n false\n false\n \n S-1\n \n 1821451322\n #g9abz11\n S-1\n \n \n NONE\n \n false\n false\n \n tonotify@company.com\n \n \n \n doc1.txt\n S-1\n KioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqDQpGaXJzdCBkb2N1bWVu\ndA0KDQogICAgICAgIFNQRUNJTUVOIC0gTk9UIEFOIE9GRklDSUFMIEZJTElORw0KDQoqKioq\nKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioNCg0K\n\n \n \n doc2.txt\n COVER\n KioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqDQpBZHZhbmNlZCBTb2Z0\nd2FyZSBTeXN0ZW1zDQogICAgICAgIFNQRUNJTUVOIC0gTk9UIEFOIE9GRklDSUFMIEZJTElO\nRw0KDQoqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioNCg0K\n\n \n \n \n \n \n 0001125851\n #tech123\n \n FEDWIRE\n 14.40\n \n \n Debt\n 1101\n 1000.0000\n 110102.36\n \n \n" } }, "schema" : { "type" : "string", "format" : "xml" } }, "application/xml" : { "examples" : { "Single Live Submission (8-K)" : { "description" : "A valid single live 8-K submission", "value" : "\n\n TEST\n \n false\n false\n false\n \n 8-K\n \n 1821451321\n #decb44a\n \n \n NONE\n \n \n 1.01\n \n true\n \n \n file.txt\n 8-K\n dGVzdA==\n \n \n" }, "Single Live Submission (S-1)" : { "description" : "A valid single live S-1 submission", "value" : "\n\n TEST\n \n false\n false\n false\n false\n \n S-1\n \n 1821451322\n #g9abz11\n S-1\n \n \n NONE\n \n false\n false\n \n tonotify@company.com\n \n \n \n doc1.txt\n S-1\n KioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqDQpGaXJzdCBkb2N1bWVu\ndA0KDQogICAgICAgIFNQRUNJTUVOIC0gTk9UIEFOIE9GRklDSUFMIEZJTElORw0KDQoqKioq\nKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioNCg0K\n\n \n \n doc2.txt\n COVER\n KioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqDQpBZHZhbmNlZCBTb2Z0\nd2FyZSBTeXN0ZW1zDQogICAgICAgIFNQRUNJTUVOIC0gTk9UIEFOIE9GRklDSUFMIEZJTElO\nRw0KDQoqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioNCg0K\n\n \n \n \n \n \n 0001125851\n #tech123\n \n FEDWIRE\n 14.40\n \n \n Debt\n 1101\n 1000.0000\n 110102.36\n \n \n" } }, "schema" : { "type" : "string", "format" : "xml" } } }, "required" : true }, "responses" : { "202" : { "description" : "Accepted. The filing has been transmitted to the SINGLE TEST resource and the EDGAR system has generated an accession number. The submission has begun processing.", "content" : { "application/json" : { "examples" : { "Accepted" : { "summary" : "Accepted. The SINGLE TEST filing has been transmitted to EDGAR and accession number(s) generated", "description" : "Accepted. The filing has been transmitted to the SINGLE TEST resource and the EDGAR system has generated an accession number. The submission has begun processing.", "value" : { "tracking" : "66ff8850f952de766df03a21da71fe69", "locator" : "47a94d", "accessionNumber" : "0000000000-25-000001", "mode" : "TEST", "status" : "RECEIVED", "transmissionStatus" : "RECEIVED" } } }, "schema" : { "$ref" : "#/components/schemas/SingleSubmissionResponse" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "examples" : { "Blank/Empty CIK for X-EDGAR-LOGIN-CIK" : { "description" : "If the header X-EDGAR-LOGIN-CIK (or X-EDGAR-CIK) is provided it must not be blank or empty.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "If the header X-EDGAR-LOGIN-CIK (or X-EDGAR-CIK) is provided it must not be blank or empty." } ] } }, "Invalid CIK for X-EDGAR-LOGIN-CIK" : { "description" : "If the header X-EDGAR-LOGIN-CIK (or X-EDGAR-CIK) is provided it must be a valid CIK.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "If the header X-EDGAR-LOGIN-CIK (or X-EDGAR-CIK) is provided it must be a valid CIK." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.", "content" : { "application/json" : { "examples" : { "Unauthorized" : { "description" : "The request does not include any valid tokens for accessing this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Unauthorized" } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "403" : { "description" : "Forbidden. A valid Filer API Token and User Access Token must be provided with this request. Please ensure that the User identified by the User Access Token is authorized to file (1) for the CIK associated with the Filer API Token and (2) for any CIKs for which filings are being submitted.", "content" : { "application/json" : { "examples" : { "Forbidden" : { "description" : "The Filer API Token and User API Token are present and valid but do not provide required permissions to use this resource. Check delegation and permissions in Filer Management.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Forbidden." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "500" : { "description" : "Server error. An unexpected server-side error has occurred.", "content" : { "application/json" : { "examples" : { "Server Error" : { "description" : "An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "An unexpected error has occurred." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "A request was made to this resource outside of operational hours.", "content" : { "application/json" : { "examples" : { "Out of Operational Hours" : { "description" : "A request was made to this resource outside of the windows of operation for the EDGAR system and this request could not be completed. This status is also returned when the operational status of EDGAR cannot be determined.", "value" : { "tracking" : "44230c24bc6ce1b884cc5b739819d29942", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "EDGAR is not available because EDGAR is reporting that it is not within operating hours." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "security" : [ { "Filer API Token and User API Token" : [ ] } ], "servers" : [ { "url" : "https://api.edgarfiling.sec.gov", "description" : "EDGAR Submission API" } ] } }, "/submission/status" : { "post" : { "summary" : "Check Multiple Submission Statuses", "description" : "When an authorized filer requests the status of multiple submissions that the filer made, the Check Multiple Submission Statuses API will respond with the current status of each, if available.", "operationId" : "Check Multiple Submission Statuses", "tags" : [ "Submission Status API" ], "requestBody" : { "description" : "A list of accession numbers as strings that the authorized filer is requesting status for. Please note that the maximum number of accession numbers that can be included in a single request is 25.", "content" : { "application/json" : { "examples" : { "Single Status" : { "summary" : "A request for a single accession number, in a list", "description" : "A request for a single accession number, in a list", "value" : { "accessionNumbers" : [ "0000000000-22-000000" ] } }, "Multiple> Statuses" : { "summary" : "A request for multiple accession numbers, in a list", "description" : "A request for multiple accession numbers, in a list", "value" : { "accessionNumbers" : [ "0000000000-22-000000", "0000000000-22-000001", "0000000000-22-000002" ] } } }, "schema" : { "$ref" : "#/components/schemas/MultipleAccessionNumberRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "Ok. A submission filed by the authorized filer, with at least one of the given accession numbers, was found", "content" : { "application/json" : { "examples" : { "Multiple Statuses" : { "summary" : "A list of statuses showing a status for each accession number requested.", "description" : "A list of statuses for the requested accession numbers.", "value" : { "tracking" : "5e981101d4bfdee09b95c6f1d53e8551", "locator" : "l33922", "responses" : [ { "accessionNumber" : "0000000000-22-000004", "status" : "DONE", "final" : true, "mode" : "LIVE", "company" : "TEST COMPANY", "documentCount" : "1", "submissionType" : "8-K", "receivedDate" : "2024-08-01T19:20:12.743Z", "acceptedDate" : "2024-10-03T13:11:35.732Z", "filingDate" : "2024-10-03T13:12:42.461Z", "notification" : "U3ViamVjdDogQUNDRVBURUQgRk9STSBUWVBFIDgtSyAoMDAwMDAwMDAwMC0yMi0wMDAwMDQpCkRhdGU6IDAzLU9jdC0yMDI0IDA5OjExCgpUSEUgRk9MTE9XSU5HIFNVQk1JU1NJT04gSEFTIEJFRU4gQUNDRVBURUQgQlkgVEhFIFUuUy4gU0VDVVJJVElFUyBBTkQgRVhDSEFOR0UgCkNPTU1JU1NJT04uCgoKRk9STSBUWVBFOiAgICAgOC1LICAgICAgICBOVU1CRVIgT0YgRE9DVU1FTlRTOiAxClJFQ0VJVkVEIERBVEU6IDAxLUF1Zy0yMDI0IDE1OjIwICAgIEFDQ0VQVEVEIERBVEU6ICAgICAgIDAzLU9jdC0yMDI0IDA5OjExClRFU1QgRklMSU5HOiAgIE5PICAgICAgICAgICAgICAgICAgIENPTkZJUk1JTkcgQ09QWTogICAgIE5PCgpBQ0NFU1NJT04gTlVNQkVSOiAwMDAwMDAwMDAwLTIyLTAwMDAwNAoKUExFQVNFIFJFRkVSIFRPIFRIRSBBQ0NFU1NJT04gTlVNQkVSIExJU1RFRCBBQk9WRSBGT1IgRlVUVVJFIElOUVVJUklFUy4KClRoZSBFREdBUiBzeXN0ZW0gaXMgYXZhaWxhYmxlIHRvIHJlY2VpdmUgYW5kIHByb2Nlc3MgZmlsaW5ncyBmcm9tIAo2OjAwIGEubS4gdG8gMTA6MDAgcC5tLiBFYXN0ZXJuIFRpbWUgb24gYnVzaW5lc3MgZGF5cy4gRmlsZXIgU3VwcG9ydApzdGFmZiBtZW1iZXJzIGFyZSBhdmFpbGFibGUgdG8gcmVzcG9uZCB0byByZXF1ZXN0cyBmb3IgYXNzaXN0YW5jZSBmcm9tCjk6MDAgYS5tLiB0byA1OjMwIHAubS4gRWFzdGVybiBUaW1lLiAKCldlIGVuY291cmFnZSB5b3UgdG8gdmlzaXQgdGhlIEVER0FSIC0gSW5mb3JtYXRpb24gZm9yIEZpbGVycyB3ZWJwYWdlIGF0IApTRUMuZ292IHwgRURHQVIgLSBJbmZvcm1hdGlvbiBmb3IgRmlsZXJzIFtodHRwczovL3d3dy5zZWMuZ292L2VkZ2FyL2ZpbGVyLWluZm9ybWF0aW9uIF0uIApPbiB0aGlzIHdlYnBhZ2UgeW91IGNhbiB2aWV3IGFuZC9vciBkb3dubG9hZCB0aGUgRURHQVIgRmlsZXIgTWFudWFsLCBhY2Nlc3MgSG93IApEbyBJJ3MsIGFuZCBhbHNvIGdldCBhY2Nlc3MgdG8gcmVzb3VyY2VzIGFuZCBhbm5vdW5jZW1lbnRzLg==", "items" : [ ], "submissionMessages" : [ ], "fileNumbers" : [ ], "registrants" : [ { "cik" : "0000000000", "company" : "TEST COMPANY", "formType" : "8-K", "fileNumbers" : [ ] } ], "messages" : [ { "type" : "WARNING", "message" : "The CIK 0000000000 needs annual confirmation in 18 days." } ] }, { "accessionNumber" : "0000000000-22-000003", "status" : "SUSPENDED", "type" : "TEST", "messages" : [ { "type" : "ERROR", "message" : "The submission requires an existing file number" } ] }, { "accessionNumber" : "0000000000-22-000001", "status" : "RECEIVED", "final" : "false", "messages" : [ ] }, { "accessionNumber" : "0000000000-22-000002", "type" : "LIVE", "status" : "BLOCKED", "messages" : [ { "type" : "INFO", "message" : "Fee-polling" } ] } ] } } }, "schema" : { "$ref" : "#/components/schemas/ListSubmissionStatusResponse" } } } }, "204" : { "description" : "No Content. None of the provided accession numbers were found even though the request was authorized." }, "400" : { "description" : "Bad Request. A correctly formed list of valid accession numbers must be provided.", "content" : { "application/json" : { "examples" : { "Bad Request" : { "description" : "Bad Request. A correctly formed list of valid accession numbers must be provided.", "value" : { "tracking" : "820c24bc6ce9ce84cc5b739819d27742", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Bad Request" } ] } }, "Too Many Accession Numbers" : { "description" : "Bad Request. Accession numbers exceeded the limit. The maximum number of allowed accession numbers is 25.", "value" : { "tracking" : "820c24bc6ce9ce84cc5b739819d27742", "messages" : [ { "type" : "ERROR", "content" : "Accession numbers exceeded the limit. The maximum number of allowed accession numbers is 25." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.", "content" : { "application/json" : { "examples" : { "Unauthorized" : { "description" : "The request does not include any valid tokens for accessing this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Unauthorized" } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "403" : { "description" : "Forbidden. This resource requires a valid Filer API Token. Please ensure that the token that is being used is a Filer API Token and is active in Filer Management.", "content" : { "application/json" : { "examples" : { "Forbidden" : { "description" : "The request has included at least one valid token but that token do not give access to this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Forbidden." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "500" : { "description" : "Server error. An unexpected server-side error has occurred.", "content" : { "application/json" : { "examples" : { "Server Error" : { "description" : "An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "An unexpected error has occurred." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "A request was made to this resource outside of operational hours.", "content" : { "application/json" : { "examples" : { "Out of Operational Hours" : { "description" : "A request was made to this resource outside of the windows of operation for the EDGAR system and this request could not be completed. This status is also returned when the operational status of EDGAR cannot be determined.", "value" : { "tracking" : "44230c24bc6ce1b884cc5b739819d29942", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "EDGAR is not available because EDGAR is reporting that it is not within operating hours." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "security" : [ { "Filer API Token" : [ ] } ], "servers" : [ { "url" : "https://api.edgarfiling.sec.gov", "description" : "EDGAR Submission API" } ] } }, "/submission/{accessionNumber}/status" : { "get" : { "summary" : "Check Single Submission Status", "description" : "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.", "operationId" : "Check Single Submission Status", "tags" : [ "Submission Status API" ], "parameters" : [ { "description" : "The accession number returned when a submission is successfully transmitted.", "example" : "0000000000-24-000001", "in" : "path", "name" : "accessionNumber", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Ok. A submission filed by the authorized filer, with the given accession number, was found", "content" : { "application/json" : { "examples" : { "Accepted with no messages" : { "description" : "The submission has been received but no filer notifications have been produced", "value" : { "tracking" : "5e981101d4bfdee09b95c6f1d53e8551", "locator" : "l33922", "accessionNumber" : "0000000000-22-000001", "status" : "RECEIVED", "final" : "false", "messages" : [ ] } }, "Done with warning about annual confirmation expiration" : { "description" : "The submission has finished processing and there are messages available", "value" : { "tracking" : "5e981101d4bfdee09b95c6f1d53e8551", "locator" : "l33922", "accessionNumber" : "0000000000-22-000004", "status" : "DONE", "final" : true, "mode" : "LIVE", "company" : "TEST COMPANY", "documentCount" : "1", "submissionType" : "8-K", "receivedDate" : "2024-08-01T19:20:12.743Z", "acceptedDate" : "2024-10-03T13:11:35.732Z", "filingDate" : "2024-10-03T13:12:42.461Z", "notification" : "U3ViamVjdDogQUNDRVBURUQgRk9STSBUWVBFIDgtSyAoMDAwMDAwMDAwMC0yMi0wMDAwMDQpCkRhdGU6IDAzLU9jdC0yMDI0IDA5OjExCgpUSEUgRk9MTE9XSU5HIFNVQk1JU1NJT04gSEFTIEJFRU4gQUNDRVBURUQgQlkgVEhFIFUuUy4gU0VDVVJJVElFUyBBTkQgRVhDSEFOR0UgCkNPTU1JU1NJT04uCgoKRk9STSBUWVBFOiAgICAgOC1LICAgICAgICBOVU1CRVIgT0YgRE9DVU1FTlRTOiAxClJFQ0VJVkVEIERBVEU6IDAxLUF1Zy0yMDI0IDE1OjIwICAgIEFDQ0VQVEVEIERBVEU6ICAgICAgIDAzLU9jdC0yMDI0IDA5OjExClRFU1QgRklMSU5HOiAgIE5PICAgICAgICAgICAgICAgICAgIENPTkZJUk1JTkcgQ09QWTogICAgIE5PCgpBQ0NFU1NJT04gTlVNQkVSOiAwMDAwMDAwMDAwLTIyLTAwMDAwNAoKUExFQVNFIFJFRkVSIFRPIFRIRSBBQ0NFU1NJT04gTlVNQkVSIExJU1RFRCBBQk9WRSBGT1IgRlVUVVJFIElOUVVJUklFUy4KClRoZSBFREdBUiBzeXN0ZW0gaXMgYXZhaWxhYmxlIHRvIHJlY2VpdmUgYW5kIHByb2Nlc3MgZmlsaW5ncyBmcm9tIAo2OjAwIGEubS4gdG8gMTA6MDAgcC5tLiBFYXN0ZXJuIFRpbWUgb24gYnVzaW5lc3MgZGF5cy4gRmlsZXIgU3VwcG9ydApzdGFmZiBtZW1iZXJzIGFyZSBhdmFpbGFibGUgdG8gcmVzcG9uZCB0byByZXF1ZXN0cyBmb3IgYXNzaXN0YW5jZSBmcm9tCjk6MDAgYS5tLiB0byA1OjMwIHAubS4gRWFzdGVybiBUaW1lLiAKCldlIGVuY291cmFnZSB5b3UgdG8gdmlzaXQgdGhlIEVER0FSIC0gSW5mb3JtYXRpb24gZm9yIEZpbGVycyB3ZWJwYWdlIGF0IApTRUMuZ292IHwgRURHQVIgLSBJbmZvcm1hdGlvbiBmb3IgRmlsZXJzIFtodHRwczovL3d3dy5zZWMuZ292L2VkZ2FyL2ZpbGVyLWluZm9ybWF0aW9uIF0uIApPbiB0aGlzIHdlYnBhZ2UgeW91IGNhbiB2aWV3IGFuZC9vciBkb3dubG9hZCB0aGUgRURHQVIgRmlsZXIgTWFudWFsLCBhY2Nlc3MgSG93IApEbyBJJ3MsIGFuZCBhbHNvIGdldCBhY2Nlc3MgdG8gcmVzb3VyY2VzIGFuZCBhbm5vdW5jZW1lbnRzLg==", "items" : [ ], "submissionMessages" : [ ], "fileNumbers" : [ ], "registrants" : [ { "cik" : "0000000000", "company" : "TEST COMPANY", "formType" : "8-K", "fileNumbers" : [ ] } ], "messages" : [ { "type" : "WARNING", "message" : "The CIK 0000000000 needs annual confirmation in 18 days." } ] } }, "Suspended with specific SEF example error" : { "description" : "The submission is suspended with SEF information regarding the reason", "value" : { "tracking" : "22981135d4bfdff09b95c6f1d53e8551", "locator" : "l33922", "accessionNumber" : "0000000000-22-000002", "type" : "TEST", "final" : "true", "status" : "SUSPENDED", "submissionMessages" : [ { "type" : "ERROR", "message" : "Value for Period of Report is missing or invalid.", "errorNumber" : "442", "ranking" : "8", "docSequenceNumber" : "0", "lineNumber" : "0", "lineOffset" : "0", "errorLabel" : "TAG_VALUE_MISSING_OR_INVALID" } ] } } }, "schema" : { "$ref" : "#/components/schemas/SingleSubmissionStatusResponse" } } } }, "404" : { "description" : "Not Found. No matching accession number found even though the request was authorized and a validly formatted accession number was provided.", "content" : { "application/json" : { "examples" : { "No submission information found" : { "description" : "No submission information found", "value" : { "tracking" : "ddb81101d4bfdee09b95c6f1233e8551", "locator" : "l33922", "messages" : [ { "type" : "INFO", "message" : "No submission found for '0000000000-22-000001'" } ] } } }, "schema" : { "$ref" : "#/components/schemas/SingleSubmissionStatusResponse" } } } }, "400" : { "description" : "Bad Request. A validly formatted accession number must be provided.", "content" : { "application/json" : { "examples" : { "Bad Request" : { "description" : "Bad request. A valid accession number must be provided.", "value" : { "tracking" : "d1230c24bc6ce9ce84cc5b739819d27742", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Accession number '0000000000-22-0000011' is not in the correct format for an accession number, ##########-##-######" } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "Unauthorized. This resource is being accessed with invalid or inactive tokens. Please check that the tokens in use are active in Filer Management or are assigned to active individuals.", "content" : { "application/json" : { "examples" : { "Unauthorized" : { "description" : "The request does not include any valid tokens for accessing this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Unauthorized" } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "403" : { "description" : "Forbidden. This resource requires a valid Filer API Token. Please ensure that the token that is being used is a Filer API Token and is active in Filer Management.", "content" : { "application/json" : { "examples" : { "Forbidden" : { "description" : "The request has included at least one valid token but that token do not give access to this resource.", "value" : { "tracking" : "68e8ce7c1552544bccbdccd2663dced4", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "Forbidden." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "500" : { "description" : "Server error. An unexpected server-side error has occurred.", "content" : { "application/json" : { "examples" : { "Server Error" : { "description" : "An unexpected internal error has occurred processing this request. Contact EDGAR Help Desk with your tracking number to troubleshoot.", "value" : { "tracking" : "937de162bf9f1b6e7fc2bfb1165c1998", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "An unexpected error has occurred." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "A request was made to this resource outside of operational hours.", "content" : { "application/json" : { "examples" : { "Out of Operational Hours" : { "description" : "A request was made to this resource outside of the windows of operation for the EDGAR system and this request could not be completed. This status is also returned when the operational status of EDGAR cannot be determined.", "value" : { "tracking" : "44230c24bc6ce1b884cc5b739819d29942", "locator" : "19ab67", "messages" : [ { "type" : "ERROR", "content" : "EDGAR is not available because EDGAR is reporting that it is not within operating hours." } ] } } }, "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "security" : [ { "Filer API Token" : [ ] } ], "servers" : [ { "url" : "https://api.edgarfiling.sec.gov", "description" : "EDGAR Submission API" } ] } } } }