[Sandbox] Simulate filing

Simulate Check submitting a filing to the agency

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Only supported in Sandbox. In production this endpoint returns a 404.

Simulates Check submitting a filing to the agency and transitions the filing to the requested status: pending, submitted, or filed. When status is omitted, the filing transitions to filed. Returns the updated Filing object as if Check had completed the filing.

The filing must be in pending status and must have filing data. Filing data is generated by Refresh filings, so call that endpoint for the company first. A filing that is blocked cannot be simulated until its blocked reasons are removed with Remove blocked reason.

You will receive an updated webhook with the topic company_filing, containing the modified data.

Possible error codesCause
simulation_not_allowedThe filing is not in pending status, the requested status is not one of pending, submitted, or filed, or no filing data exists for the filing.
Path Params
string
required

ID of the company filing

Body Params
string
enum
Defaults to filed

Status to transition the filing to. Defaults to filed.

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json