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. Most blocker IDs from the Filing blockers table are accepted, which is broader than the production Add filing blockers endpoint. Two kinds are refused:
- Blockers that Check sets automatically:
applied_for_tax_id,missing_tax_funds,collection_failed, andcompany_bad_standing. These can't be added through this endpoint. - Blockers that apply only in certain cases, such as
incorrect_experience_factor, which applies only to Washington L&I filings. Adding one to a filing it doesn't apply to returns an error whose message explains why.
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. |
rule_violation | The blocker is one that Check sets automatically and cannot be added through this endpoint. |
manual_issue_policy_violation | The blocker doesn't apply to this filing, for example because it applies only to certain agencies' filings. The error message explains why. |
resource_not_found | The blocker ID does not exist. |