post
https://sandbox.checkhq.com/filings//simulate/add_blocked_reason
Simulate a filing failure by adding a blocked reason
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Only supported in Sandbox. In production this endpoint returns a 404.
Adds a blocked reason to a filing to simulate a filing failure. The filing transitions to blocked, and the response is the updated Filing object.
The filing must be in pending or blocked status. Any blocker ID from the Filing blockers table is accepted, which is broader than the production Add filing blockers endpoint. An optional note can be attached to the blocked reason. If the blocked reason is already present on the filing, sending a note updates it and the request is otherwise a no-op.
You will receive an updated webhook with the topic company_filing, containing the modified data.
| Possible error codes | Cause |
|---|---|
simulation_not_allowed | The filing is not in pending or blocked status. |
manual_issue_policy_violation | A manual issue policy prevents the requested change. The error message describes the policy that blocked it. |