Add filing blockers

Add manual blockers to a filing

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

Adds one or more blockers to a filing and returns the updated Filing object.

The request body accepts a blockers array of blocker IDs. Blockers can only be added to filings in blocked or pending status. Filings that are submitted, filed, or inapplicable cannot be blocked.

In production, partners can add only the held_by_customer blocker through this endpoint. In Sandbox, filed_by_customer, customer_filing_required, invalid_ssn, inactive_account, and fein_tax_id_mismatch are also accepted so that the resulting blocked states can be tested.

See the Filing blockers table for the full list of blocker IDs and how each one is resolved.

Possible error codesCause
blockers_already_presentOne or more of the requested blockers is already open on the filing.
blockers_not_addableOne or more of the requested blockers cannot be added through the API, or the filing is in a status that does not accept blockers.
manual_issue_policy_violationA manual issue policy prevents the requested change. The error message describes the policy that blocked it.
Path Params
string
required

ID of the company filing

Body Params
blockers
array of strings
required

List of blocker IDs to add to the filing. In production, only held_by_customer is supported. In Sandbox, filed_by_customer, customer_filing_required, invalid_ssn, inactive_account, and fein_tax_id_mismatch are also accepted.

blockers*
Responses

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