CHcheckhq

[Sandbox] Simulate filing

Changed on

Simulate Check submitting a filing to the agency and transition it to the requested status. Sandbox-only: in production this endpoint returns a 404.

The filing must be in pending status and must have filing data, which is generated by Refresh filings. Returns the updated filing. An updated webhook with the company_filing topic is sent.

post/filings/{filing_id}/simulate/simulate_filing

Request

Path parameters

filing_idstring required

ID of the company filing

Request body

status'pending' | 'submitted' | 'filed'

Status to transition the filing to. Defaults to filed.

Example request

{
  "status": "filed"
}

Response

200

idstring
companystring
yearinteger
periodstring
labelstring
jurisdictionstring nullable

Lowercase region code for the filing (fed or lowercased ISO 3166-2:US region code).

agencystring nullable

ID of the Agency that receives this filing.

due_atstring
filed_atstring nullable
closed_atstring nullable
documentstring nullable
filing_attemptsinteger
amendsstring[]
amended_bystring[]
statusstring

Example response

{
  "id": "com_fil_AaeJoEAzbqqc2D9GMr3R",
  "company": "com_vIFHhvyGN47ej1upyIT8",
  "year": 2025,
  "period": "q1",
  "label": "Federal Quarterly Filing - Q1",
  "jurisdiction": "fed",
  "agency": "agc_ukjABgbD0hQ3dfBRyMPD",
  "due_at": "2025-04-30",
  "closed_at": "2025-04-25T00:00:00.000Z",
  "status": "blocked",
  "status_history": [
    {
      "status": "blocked",
      "status_at": "2025-04-20T15:30:00.000Z",
      "blocked_reasons": [
        {
          "type": "held_by_customer"
        }
      ]
    }
  ]
}

Changes